home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / ubt101.zip / UBT-DOC.ZIP / UBTSYSOP.DOC < prev    next >
Text File  |  1992-04-05  |  154KB  |  3,185 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                    U - B O A T
  22.  
  23.                            Version 1.00 - Apr 03, 1992
  24.  
  25.                                SysOp Documentation
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  59.   U-Boat SysOps Documentation - Version 1.00                            Page i
  60.   ----------------------------------------------------------------------------
  61.  
  62.  
  63.                                   TABLE OF CONTENTS
  64.  
  65.         1.0 Introduction. . . . . . . . . . . . . . . . . . . . . . . . .  1
  66.  
  67.         2.0 System Requirements . . . . . . . . . . . . . . . . . . . . .  2
  68.  
  69.         3.0 Version History . . . . . . . . . . . . . . . . . . . . . . .  3
  70.  
  71.         4.0 Installation & Setup. . . . . . . . . . . . . . . . . . . . .  4
  72.             4.1 The Configurations File . . . . . . . . . . . . . . . . .  4
  73.                 LANG:   Default Language. . . . . . . . . . . . . . . . .  4
  74.                 DOCS:   Documentation File. . . . . . . . . . . . . . . .  5
  75.                 BULL:   Highest Rated Players Bulletin (B/W). . . . . . .  5
  76.                 BULLC:  Highest Rated Players Bulletin (Color). . . . . .  5
  77.                 BULL2:  High Game Scores Bulletin (B/W) . . . . . . . . .  6
  78.                 BULLC2: High Game Scores Bulletin (Color) . . . . . . . .  6
  79.                 ALIAS:  Allow Alias Toggle. . . . . . . . . . . . . . . .  6
  80.                 EDIT1:  Editor User 1 . . . . . . . . . . . . . . . . . .  6
  81.                 EDIT2:  Editor User 2 . . . . . . . . . . . . . . . . . .  7
  82.                 EDIT3:  Editor User 3 . . . . . . . . . . . . . . . . . .  7
  83.                 PASWD:  Editor Password . . . . . . . . . . . . . . . . .  7
  84.                 SNOOP:  Snoop Toggle. . . . . . . . . . . . . . . . . . .  8
  85.                 PROTO:  External Protocol Name. . . . . . . . . . . . . .  8
  86.                 BATCH:  External Transfer Batch Filename  . . . . . . . .  8
  87.                 EXT1:   Documentation Extention #1 (ASCII). . . . . . . .  9
  88.                 EXT2:   Documentation Extention #2 (ASCII Compressed) . .  9
  89.                 EXT3:   Documentation Extention #3 (PCL-4). . . . . . . .  9
  90.                 EXT4:   Documentation Extention #4 (PCL-4 Compressed) . . 10
  91.                 PURGE:  Old Player Purge. . . . . . . . . . . . . . . . . 10
  92.                 RESETS: Automatic High Scores Reset . . . . . . . . . . . 10
  93.                 RESETR: Automatic Player Ratings Reset. . . . . . . . . . 10
  94.                 PAUSE:  24 Line Pause Sequence for Bulletins. . . . . . . 11
  95.             4.2 The Batch File. . . . . . . . . . . . . . . . . . . . . . 11
  96.             4.3 Node & Port Files . . . . . . . . . . . . . . . . . . . . 12
  97.                 NODES.BBS - The Node ID File. . . . . . . . . . . . . . . 12
  98.                 PORTS.BBS - The Port ID File. . . . . . . . . . . . . . . 12
  99.             4.4 BBS Support Files . . . . . . . . . . . . . . . . . . . . 13
  100.                 RBBS Support Files. . . . . . . . . . . . . . . . . . . . 13
  101.                 Quick BBS Support Files . . . . . . . . . . . . . . . . . 14
  102.                 Wildcat Support Files . . . . . . . . . . . . . . . . . . 14
  103.                 PC-Board Support Files. . . . . . . . . . . . . . . . . . 14
  104.                 GAP Support Files . . . . . . . . . . . . . . . . . . . . 15
  105.                 WWIV Support Files. . . . . . . . . . . . . . . . . . . . 15
  106.                 Spitfire Support Files. . . . . . . . . . . . . . . . . . 15
  107.                 G-Mon Support Files . . . . . . . . . . . . . . . . . . . 16
  108.             4.5 Timegen Utility . . . . . . . . . . . . . . . . . . . . . 17
  109.                 SYSOP - SysOp Paging Hours. . . . . . . . . . . . . . . . 17
  110.                 LEVEL - Security Level Definitions. . . . . . . . . . . . 17
  111.                 DAYT - Daily Time Limits. . . . . . . . . . . . . . . . . 17
  112.                 DAYG - Daily Game Entry Limits. . . . . . . . . . . . . . 18
  113.                 WAIT - Wait Times Between Game Entries. . . . . . . . . . 18
  114.                 TIME - Max Entry Time Definitions . . . . . . . . . . . . 18
  115.  
  116.   ----------------------------------------------------------------------------
  117.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  118.   U-Boat SysOps Documentation - Version 1.00                           Page ii
  119.   ----------------------------------------------------------------------------
  120.  
  121.  
  122.                                TABLE OF CONTENTS (cont)
  123.  
  124.         5.0 Maintenance Options . . . . . . . . . . . . . . . . . . . . . 19
  125.             5.1 Automatic Maintenance . . . . . . . . . . . . . . . . . . 19
  126.             5.2 Old Player Purging. . . . . . . . . . . . . . . . . . . . 19
  127.             5.3 Resetting Player Ratings. . . . . . . . . . . . . . . . . 19
  128.             5.4 Resetting Game High Scores. . . . . . . . . . . . . . . . 20
  129.             5.5 Resetting Full Game . . . . . . . . . . . . . . . . . . . 20
  130.             5.6 Restarting the Game . . . . . . . . . . . . . . . . . . . 21
  131.  
  132.         6.0 Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
  133.             6.1  Player Editor. . . . . . . . . . . . . . . . . . . . . . 23
  134.                  Selecting Players. . . . . . . . . . . . . . . . . . . . 23
  135.                  Player Status. . . . . . . . . . . . . . . . . . . . . . 23
  136.                  Active Game. . . . . . . . . . . . . . . . . . . . . . . 23
  137.                  Player Login . . . . . . . . . . . . . . . . . . . . . . 24
  138.                  Player Alias . . . . . . . . . . . . . . . . . . . . . . 24
  139.                  Player Password. . . . . . . . . . . . . . . . . . . . . 24
  140.                  Player Ship. . . . . . . . . . . . . . . . . . . . . . . 24
  141.                  Last Date Played . . . . . . . . . . . . . . . . . . . . 25
  142.                  Total Time Played. . . . . . . . . . . . . . . . . . . . 25
  143.                  Total Game Entries . . . . . . . . . . . . . . . . . . . 25
  144.                  Language Setting . . . . . . . . . . . . . . . . . . . . 25
  145.                  Graphics Setting . . . . . . . . . . . . . . . . . . . . 26
  146.                  Message Delay Setting. . . . . . . . . . . . . . . . . . 26
  147.                  Current Games Total. . . . . . . . . . . . . . . . . . . 26
  148.                  Current Score Total. . . . . . . . . . . . . . . . . . . 26
  149.                  Current Rating . . . . . . . . . . . . . . . . . . . . . 26
  150.                  All Time Games Total . . . . . . . . . . . . . . . . . . 27
  151.                  All Time Score Total . . . . . . . . . . . . . . . . . . 27
  152.                  All Time High Rating . . . . . . . . . . . . . . . . . . 27
  153.                  Edit Current High Scores . . . . . . . . . . . . . . . . 27
  154.                  Edit All Time High Scores. . . . . . . . . . . . . . . . 27
  155.                  Save Player. . . . . . . . . . . . . . . . . . . . . . . 28
  156.                  Exit Player Editor . . . . . . . . . . . . . . . . . . . 28
  157.             6.2  Ratings Editor . . . . . . . . . . . . . . . . . . . . . 28
  158.                  Editing Player Ratings . . . . . . . . . . . . . . . . . 28
  159.                  Changing Last Reset Date . . . . . . . . . . . . . . . . 28
  160.                  Saving Rating Information. . . . . . . . . . . . . . . . 29
  161.                  Discarding Rating Information. . . . . . . . . . . . . . 29
  162.             6.3  High Scores Editor . . . . . . . . . . . . . . . . . . . 29
  163.                  1st and 2nd Place Player Information . . . . . . . . . . 29
  164.                  Players Name/Alias . . . . . . . . . . . . . . . . . . . 29
  165.                  Players Ship Name. . . . . . . . . . . . . . . . . . . . 29
  166.                  Players Score. . . . . . . . . . . . . . . . . . . . . . 29
  167.                  Date Game Was Played . . . . . . . . . . . . . . . . . . 30
  168.                  Changing Last Reset Date . . . . . . . . . . . . . . . . 30
  169.                  Previous Game Information. . . . . . . . . . . . . . . . 30
  170.                  Next Game Information. . . . . . . . . . . . . . . . . . 30
  171.                  Saving High Scores . . . . . . . . . . . . . . . . . . . 30
  172.                  Exiting High Scores Editor . . . . . . . . . . . . . . . 30
  173.  
  174.  
  175.   ----------------------------------------------------------------------------
  176.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  177.   U-Boat SysOps Documentation - Version 1.00                          Page iii
  178.   ----------------------------------------------------------------------------
  179.  
  180.  
  181.                                TABLE OF CONTENTS (cont)
  182.  
  183.             6.4  Games in Progress Editor . . . . . . . . . . . . . . . . 31
  184.                  Changing Games . . . . . . . . . . . . . . . . . . . . . 31
  185.                  Game Number. . . . . . . . . . . . . . . . . . . . . . . 31
  186.                  Game Turn. . . . . . . . . . . . . . . . . . . . . . . . 31
  187.                  Game Score . . . . . . . . . . . . . . . . . . . . . . . 31
  188.                  Sub Bases. . . . . . . . . . . . . . . . . . . . . . . . 32
  189.                  Destroyer Bases. . . . . . . . . . . . . . . . . . . . . 32
  190.                  Transport Base Location. . . . . . . . . . . . . . . . . 32
  191.                  Transport Ports. . . . . . . . . . . . . . . . . . . . . 32
  192.                  Sub Status . . . . . . . . . . . . . . . . . . . . . . . 32
  193.                  Sub Location . . . . . . . . . . . . . . . . . . . . . . 33
  194.                  Destroyer Fuel . . . . . . . . . . . . . . . . . . . . . 33
  195.                  Destroyer Depth Charges. . . . . . . . . . . . . . . . . 33
  196.                  Destroyer Location . . . . . . . . . . . . . . . . . . . 33
  197.                  Transport Launch Period. . . . . . . . . . . . . . . . . 33
  198.                  Unlaunched Transports. . . . . . . . . . . . . . . . . . 33
  199.                  Transports At Sea. . . . . . . . . . . . . . . . . . . . 33
  200.                  Transport Missions Completed . . . . . . . . . . . . . . 34
  201.                  Transport Completion Points. . . . . . . . . . . . . . . 34
  202.                  Saving Game Information. . . . . . . . . . . . . . . . . 34
  203.                  Exiting Game Editor. . . . . . . . . . . . . . . . . . . 34
  204.             6.5  Resetting High Scores. . . . . . . . . . . . . . . . . . 34
  205.             6.6  Resetting Player Ratings . . . . . . . . . . . . . . . . 35
  206.             6.7  Resetting Full Game. . . . . . . . . . . . . . . . . . . 35
  207.             6.8  Purging Old Users. . . . . . . . . . . . . . . . . . . . 35
  208.             6.9  Reviewing Program Error Log. . . . . . . . . . . . . . . 35
  209.             6.10 Exiting the Editor . . . . . . . . . . . . . . . . . . . 35
  210.  
  211.         7.0 Creating Additional Game Scenarios. . . . . . . . . . . . . . 36
  212.             7.1  Maximum Scenario Support . . . . . . . . . . . . . . . . 36
  213.             7.2  Map File Format. . . . . . . . . . . . . . . . . . . . . 36
  214.                  Seas . . . . . . . . . . . . . . . . . . . . . . . . . . 36
  215.                  Land . . . . . . . . . . . . . . . . . . . . . . . . . . 36
  216.                  Transport Base . . . . . . . . . . . . . . . . . . . . . 36
  217.                  Transport Ports. . . . . . . . . . . . . . . . . . . . . 37
  218.                  Destroyer Bases. . . . . . . . . . . . . . . . . . . . . 37
  219.                  U-Boat Bases . . . . . . . . . . . . . . . . . . . . . . 37
  220.                  Sea Lanes. . . . . . . . . . . . . . . . . . . . . . . . 37
  221.  
  222.         8.0 Notes from the Author . . . . . . . . . . . . . . . . . . . . 38
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.   ----------------------------------------------------------------------------
  235.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  236.   U-Boat SysOps Documentation - Version 1.00                           Page iv
  237.   ----------------------------------------------------------------------------
  238.  
  239.  
  240.                                       APPENDICES
  241.  
  242.         A.0 Registration Information. . . . . . . . . . . . . . . . . . . A1
  243.  
  244.         B.0 List of Files . . . . . . . . . . . . . . . . . . . . . . . . B1
  245.             B.1 Documentation Files . . . . . . . . . . . . . . . . . . . B1
  246.             B.2 Message Files . . . . . . . . . . . . . . . . . . . . . . B2
  247.             B.3 Program Files . . . . . . . . . . . . . . . . . . . . . . B3
  248.             B.4 Data Files. . . . . . . . . . . . . . . . . . . . . . . . B5
  249.  
  250.         C.0 SysOp Function Keys . . . . . . . . . . . . . . . . . . . . . C1
  251.  
  252.         D.0 Command Line Parameters . . . . . . . . . . . . . . . . . . . D1
  253.  
  254.         E.0 Multi-Lingual Support . . . . . . . . . . . . . . . . . . . . E1
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.   ----------------------------------------------------------------------------
  294.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  295.   U-Boat SysOps Documentation - Version 1.00                            Page 1
  296.   ----------------------------------------------------------------------------
  297.  
  298.         1.0 Introduction
  299.         ================
  300.  
  301.         Welcome SysOp to U-Boat.  U-Boat is a game of skill, strategy, and yes
  302.         even a bit of luck.  It is designed to run as a "door" under most
  303.         popular BBS packages, but can just as easily be run stand-alone or
  304.         in a multi-user network environment.
  305.  
  306.         If you are using the shareware/unregistered release, you, and your
  307.         users, will find several features disabled.  This is done, of course,
  308.         as an incentive for you to register the software.  We feel that enough
  309.         of the game is operational for you and your users to evaluate it.  The
  310.         following is a list of differences between the shareware and registered
  311.         versions:
  312.  
  313.                     * No access to editors by the SysOp
  314.                     * No ability to change or add game scenarios
  315.                     * Unregistered version banner at login and
  316.                       logout times.
  317.                     * Occasional unregistered version messages
  318.  
  319.         We feel that once you and your users have had time to "play around"
  320.         with the shareware version, you will want to register the software.
  321.         The registered version offers two major advantages.  The first is the
  322.         the ability to add to the 5 basic game scenarios.  This gives players
  323.         a greater variety of challenges and problems to solve.  The second
  324.         is the SysOp access to the game editors.  This is handy in being able
  325.         to delete players or visiting sysops who just wondered in once for
  326.         a look around.  It may also allow you to help some players out of
  327.         a "jam", or (God forbid) get a player out of a position he is stuck in
  328.         due to a bug in the software.
  329.  
  330.         For more information on registration please refer to appendix A and the
  331.         files REGISTER.TXT, DOORS.TXT, ORDER.TXT, and DISTRIB.TXT.
  332.  
  333.  
  334.  
  335.         NOTICE: U-BOAT IS THE PROPERTY OF MYCROFT SYSTEMS, SAN JOSE, CA.  YOU
  336.         MAY USE THE SHAREWARE VERSION OF THE GAME FOR A PERIOD OF NO MORE
  337.         THAN 45 DAYS.  AFTER THAT EVALUATION PERIOD YOU MUST EITHER REGISTER
  338.         THE SOFTWARE OR REMOVE IT FROM YOUR SYSTEM.  FAILURE TO DO SO IS A
  339.         VIOLATION OF THE SHAREWARE LICENSE AND IS IN EFFECT THEFT FROM THE
  340.         AUTHOR.
  341.  
  342.         FOR THOSE SYSTEMS WHICH REGISTER THE PROGRAM, IT IS AGAINST YOUR
  343.         LICENSE AGREEMENT TO DISTRIBUTE THE REGISTRATION FILES IN ANY FORMAT
  344.         TO ANY OTHER PARTY WITHOUT THE EXPRESSED WRITTEN PERMISSION OF MYCROFT
  345.         SYSTEMS OR THE AUTHOR.
  346.  
  347.         MYCROFT SYSTEMS ASSUMES NO LIABILITY FOR ANY DAMAGE TO YOUR EQUIPMENT
  348.         OR YOUR DATA IN ANY FORM DUE TO YOUR USE OF THIS PROGRAM.  NO WARRANTY
  349.         EXPRESSED OR IMPLIED IS PROVIDED WITH THIS SOFTWARE PACKAGE AND YOUR
  350.         USE OF THIS SOFTWARE IS ENTIRELY AT YOUR OWN RISK.
  351.  
  352.   ----------------------------------------------------------------------------
  353.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  354.   U-Boat SysOps Documentation - Version 1.00                            Page 2
  355.   ----------------------------------------------------------------------------
  356.  
  357.         2.0 System Requirements
  358.         =======================
  359.  
  360.         To run U-Boat, you will need and IBM or compatible PC computer, at
  361.         least 512K of RAM (game will run in much less), a BBS software package
  362.         compatible with the packages supported by U-Boat (or any other BBS
  363.         package combined with the use of a door conversion program), a modem,
  364.         and of course a phone line.
  365.  
  366.         The following BBS packages are directly supported by U-Boat:
  367.  
  368.                             * Auntie
  369.                             * GAP
  370.                             * PC-Board
  371.                             * Quick BBS
  372.                             * RBBS 16.x and RBBS 17.x
  373.                             * RBBS and G-Mon
  374.                             * Remote Access
  375.                             * Spitfire
  376.                             * Tag
  377.                             * Wildcat
  378.                             * WWIV
  379.  
  380.         As stated above, other software packages are either indirectly
  381.         supported, since they produce a door file compatible with one of the
  382.         above, or can be indirectly supported by using an external door
  383.         conversion program.
  384.  
  385.         Support for the game and installation is available by calling or
  386.         writting to:
  387.  
  388.  
  389.                                 Mycroft Systems BBS
  390.                                    P.O. Box 7672
  391.                                 San Jose, CA. 95150
  392.                                 BBS:  (408)927-0105
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.   ----------------------------------------------------------------------------
  412.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  413.   U-Boat SysOps Documentation - Version 1.00                            Page 3
  414.   ----------------------------------------------------------------------------
  415.  
  416.         3.0 Program History
  417.         ===================
  418.  
  419.         The following is a brief history of U-Boat along with version dates,
  420.         and software changes:
  421.  
  422.         VERSION    DATE                     DESCRIPTION
  423.         -------  --------  -------------------------------------------------
  424.           B.00   02/15/92  Original version.  Only distributed in the regis-
  425.                            tered format, this version did not include the
  426.                            game in progress editor, nor the formal SysOp do-
  427.                            cumentation.  The version suffered from several
  428.                            obvious bugs.
  429.  
  430.           B.01   03/15/92  This version was also only distributed in the
  431.                            registered format.  Several bugs were squshed.
  432.                            By adding more sea lanes to the default game
  433.                            scenario maps, the transport captains became a
  434.                            tiny bit more intelligent (up to Moron 1st grade).
  435.                            This version also repaired the bug dealing with
  436.                            some text editors not being compatible with the
  437.                            UBOAT.CFG file.  The preliminary (unedited) ver-
  438.                            sion of the SysOp documentation was also inclu-
  439.                            ded.  Default bulletin files are created by the
  440.                            maintenance reset functions to avoid the error
  441.                            messages saying that the files did not exist.
  442.                            Lastly, the SysOp function key support code was
  443.                            added.
  444.  
  445.           1.00   04/03/92  This version will include the final versions of
  446.                            the documentation.  Also the Game in Progress
  447.                            editor will be included.  Lastly, the first
  448.                            shareware version will become available.  It is
  449.                            also hoped that 1 or 2 language support sets will
  450.                            be available with release 1.00.
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.   ----------------------------------------------------------------------------
  471.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  472.   U-Boat SysOps Documentation - Version 1.00                            Page 4
  473.   ----------------------------------------------------------------------------
  474.  
  475.         4.0 Installation & Setup
  476.         ========================
  477.  
  478.         U-Boat is supplied with it's own custom INSTALL.EXE program.  It is
  479.         also fully compatible with the Standard Mycroft Command line.  It is
  480.         recommended that you install the program using the install utility, but
  481.         in the event that you cannot locate a copy, or would prefer to install
  482.         it manually, the following section will explain in detail all the in-
  483.         formation required to setup and install the door.
  484.  
  485.         The first thing to do is to create a directory that U-Boat will be
  486.         run out of.  This could be something like UBOAT, U-BOAT, or anything
  487.         else you desire.  Next create a subdirectory off of the U-Boat direc-
  488.         tory named DOCS.  Copy or unzip all of the files in the ZIP file
  489.         UBT-DOC.ZIP into the DOCS subdirectory.  Next, create a subdirectory
  490.         named MSGS and unzip all of the files in UBT-MSG.ZIP into the MSGS
  491.         directory.  Then unzip all of the files in the ZIP file UBT-BIN.ZIP
  492.         into the main U-Boat directory.  You will then need to edit/create
  493.         the files described below.
  494.  
  495.             4.1 The Configurations File
  496.             ---------------------------
  497.             The file UBOAT.CFG is the configuration file needed to control
  498.             the program.  The file is a standard ASCII text file that may be
  499.             created or edited using any standard text editor.  Do not use a
  500.             word processor to edit the program unless the word processor has
  501.             a non-document mode.  The configuartion file is made up of con-
  502.             figuration commands.  Each configuration command occupies a sin-
  503.             gle line and has a fixed format.  Blank lines in the configura-
  504.             tion file are ignored.  Comments may be imbedded in the configu-
  505.             ration file by starting the comment line with the ';' character
  506.             or by using the ';' to start a comment on a configuration line.
  507.             Configuration commands are optional and all of the values have a
  508.             default value.  Configuration commands may be in any order within
  509.             the file.  The configuration commands are described below:
  510.  
  511.                 LANG: Default Language
  512.                 ----------------------
  513.                 The LANG command is used to specify the games default language.
  514.                 The default language is used for all bulletin support, all
  515.                 shared text, and at all points where the players selected
  516.                 language is not yet known.  The default language will also be
  517.                 used for all errors written to the UBOAT.ERR file.
  518.  
  519.                 The LANG command has a single parameter.  This parameter is the
  520.                 language tag and corresponds to the language based files file
  521.                 extention.  The following language tags are defined, however
  522.                 not all of the languages are yet "coded".
  523.  
  524.                 ENG - English   code page 437    UKG - English   code page 850
  525.                 FRN - French    code page 437    FRC - French    code page 863
  526.                 SPN - Spanish   code page 437    SPS - Spanish   code page 850
  527.                 GRM - German    code page 437    GMN - German    code page 850
  528.  
  529.   ----------------------------------------------------------------------------
  530.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  531.   U-Boat SysOps Documentation - Version 1.00                            Page 5
  532.   ----------------------------------------------------------------------------
  533.  
  534.                 ITL - Italian   code page 437    ITN - Italian   code page 850
  535.                 PTG - Portugese code page 437    PTU - Portugese code page 860
  536.  
  537.                 Note that at this writting, only code page 437 (United States)
  538.                 is supported.  Others pay be added in the future.
  539.  
  540.                 Example: LANG: SPN
  541.                 Default: LANG: ENG
  542.  
  543.                 DOCS: Documentation Dir
  544.                 -----------------------
  545.                 The DOCS command is used to specify where the documentation
  546.                 files exist.  This should be the full drive and pathname, but
  547.                 relative paths are allowed.  Please be careful when using
  548.                 relative paths.
  549.  
  550.                 This command takes a single parameter.  The parameter is the
  551.                 complete drive and pathname to the documentation files
  552.                 location.  If you are using 2 or more of the documentation
  553.                 extentions (see below), then make sure that all required files
  554.                 are in the correct directory.
  555.  
  556.                 Example: DOCS: C:\UBOAT\DOCS
  557.                 Default: DOCS: DOCS
  558.  
  559.                 BULL: Highest Rated Players Bulletin (B/W)
  560.                 ------------------------------------------
  561.                 The BULL command is used to control where the Highest Rated
  562.                 Players Bulletin (ASCII) will be created.  This bulletin will
  563.                 shows the users, the top five rated players.  To qualify as
  564.                 a rated player, the player must have completed all of the
  565.                 first five scenarios at least once.
  566.  
  567.                 The BULL command has a single parameter which is the complete
  568.                 drive, path, and filename of the bulletin to be created.  Note
  569.                 that relative pathnames are allowed are are relative to the
  570.                 main U-Boat directory.
  571.  
  572.                 Example: BULL: C:\BBS\BULLETIN\BULLET10.TXT
  573.                 Default: BULL: UBTBULL.BBS
  574.  
  575.                 BULLC: Highest Rated Players Bulletin (Color)
  576.                 ---------------------------------------------
  577.                 The BULLC command is used to control where the Highest Rated
  578.                 Players Bulletin (ANSI) will be created.  This bulletin is the
  579.                 same as the one described in the BULL command except that
  580.                 ANSI color sequences & IBM extended graphics characters are
  581.                 used.
  582.  
  583.                 Example: BULLC: C:\BBS\BULLETIN\BULLET11.TXT
  584.                 Default: BULLC: UBTBULL.CLR
  585.  
  586.  
  587.   ----------------------------------------------------------------------------
  588.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  589.   U-Boat SysOps Documentation - Version 1.00                            Page 6
  590.   ----------------------------------------------------------------------------
  591.  
  592.                 BULL2: Game High Scores Bulletin (B/W)
  593.                 --------------------------------------
  594.                 The BULL2 command is used to control where the Game High
  595.                 Scores Bulletin (ASCII) will be created.  This bulletin will
  596.                 show users, the top two scores acheived for each individual
  597.                 scenario.
  598.  
  599.                 As a matter of courtesy to those players who are just learning
  600.                 the game, the players may abandon a game in progress until
  601.                 such time that they complete their first game.
  602.  
  603.                 The BULL2 command has a single parameter which is the com-
  604.                 plete drive, path, and filename of the bulletin to be created.
  605.                 Relative paths are permitted, and will be relative to the
  606.                 main U-Boat directory.
  607.  
  608.                 Example: BULL2: C:\BBS\BULLETIN\BULLET12.TXT
  609.                 Default: BULL2: UBTBULL2.BBS
  610.  
  611.                 BULLC2: Game High Scores Bulletin (Color)
  612.                 -----------------------------------------
  613.                 The BULLC2 command is used to control where the Game High
  614.                 Scores Bulletin (ANSI) will be created.  This bulletin is the
  615.                 same bulletin as the BULL2 defined above, but ANSI color
  616.                 sequences and IBM extended graphics characters are used.
  617.  
  618.                 Example: BULLC2: C:\BBS\BULLETIN\BULLET12.TXT
  619.                 Default: BULLC2: UBTBULL2.CLR
  620.  
  621.                 ALIAS: Allow Alias Toggle
  622.                 -------------------------
  623.                 The ALIAS command is used to control whether a players real
  624.                 name or his alias is displayed in any bulletins that he/she
  625.                 has qualified for.
  626.  
  627.                 The ALIAS command has a single parameter.  It should be set
  628.                 to 'ON' to allow the alias to be displayed, or to 'OFF' to
  629.                 force the players real name to be displayued.
  630.  
  631.                 Example: ALIAS OFF
  632.                 Default: ALIAS ON
  633.  
  634.                 EDIT1: Editor User 1
  635.                 --------------------
  636.                 The EDIT1 command is used to specify a users login name who has
  637.                 access to the game editors when running remotely.  When the
  638.                 door is run locally then whoever runs the program will have
  639.                 automatic access to the editors (provided they know the editor
  640.                 access password).
  641.  
  642.                 Please note that the editors may also be entered by using a
  643.                 specific command line.
  644.  
  645.  
  646.   ----------------------------------------------------------------------------
  647.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  648.   U-Boat SysOps Documentation - Version 1.00                            Page 7
  649.   ----------------------------------------------------------------------------
  650.  
  651.                 The EDIT1 command has a single parameter.  This parameter is
  652.                 the user login name of the user who is being granted access to
  653.                 the program editors.  This parameter is NOT case sensative.
  654.  
  655.                 Example: EDIT1: MIKE BAYLEY
  656.                 Default: EDIT1: SYSOP
  657.  
  658.                 EDIT2: Editor User 2
  659.                 --------------------
  660.                 The EDIT2 command is also used to specify a users login name
  661.                 who has access to the game editors when running remotely.  When
  662.                 the door is run locally then whoever runs the program will have
  663.                 automatic access to the editors.
  664.  
  665.                 The EDIT2 command has a single parameter.  This parameter is
  666.                 the user login name of the user who is being granted access to
  667.                 the program editors.
  668.  
  669.                 Example: EDIT2: MIKE BAYLEY
  670.                 Default: EDIT2:
  671.  
  672.                 EDIT3: Editor User 3
  673.                 --------------------
  674.                 The EDIT3 command is also used to specify a users login name
  675.                 who has access to the game editors when running remotely.  When
  676.                 the door is run locally then whoever runs the program will have
  677.                 automatic access to the editors.
  678.  
  679.                 The EDIT3 command has a single parameter.  This parameter is
  680.                 the user login name of the user who is being granted access to
  681.                 the program editors.
  682.  
  683.                 Example: EDIT3: MIKE BAYLEY
  684.                 Default: EDIT3:
  685.  
  686.                 PASWD: Editor Password
  687.                 ----------------------
  688.                 The PASWD command is also used to specify a password that will
  689.                 be required to gain access to the game editors when running
  690.                 remotely.  When the door is run locally then whoever runs the
  691.                 program will not be required to enter a password.
  692.  
  693.                 Please note that to access the editors, that a seperate command
  694.                 line format is used.  Also note that the editors are not
  695.                 available in the shareware copy of the program.
  696.  
  697.                 The PASWD command has a single parameter.  This parameter is
  698.                 the password required to gain access to the editors.  The
  699.                 password may be 0 or more words up to a total of 40 characters.
  700.                 The password IS case sensative.  If no password is specified,
  701.                 then no password will be required to enter the editors when
  702.                 running remotely.  It is recommended as a matter of security
  703.                 that a password be specified.
  704.  
  705.   ----------------------------------------------------------------------------
  706.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  707.   U-Boat SysOps Documentation - Version 1.00                            Page 8
  708.   ----------------------------------------------------------------------------
  709.  
  710.                 Example: PASWD: U-Boat Password
  711.                 Default: PASWD: U-BoatEdit
  712.  
  713.                 SNOOP: Snoop Toggle
  714.                 -------------------
  715.                 The SNOOP command is used to set the default setting of the
  716.                 SysOp Snoop Toggle.  If the toggle is set off, then no
  717.                 information will be sent to the local display.  If the toggle
  718.                 is set to on, then the local display will show the same
  719.                 information the user sees, plus a banner line at the bottom of
  720.                 the screen showing the user name and current version number.
  721.  
  722.                 The snoop toggle may be changed at any point a user is online
  723.                 and playing U-Boat by using the SysOp Keys (see the appendix
  724.                 on SysOp Keys for more information).
  725.  
  726.                 It is recommended that the snoop toggle be set to off when
  727.                 running in a multi-tasking environment such as Windows or
  728.                 Desqview.  By setting it to off, there will be no screen
  729.                 display and it will then make the program run faster.
  730.  
  731.                 The SNOOP command has a single parameter.  The parameter must
  732.                 be set to either ON or OFF.
  733.  
  734.                 Example: SNOOP: OFF
  735.                 Default: SNOOP: ON
  736.  
  737.                 PROTO: External Protocol Name
  738.                 -----------------------------
  739.                 The PROTO command is used to describe which external file
  740.                 transfer protocol to use when the user selects the download
  741.                 documentation feature.  The protocol is defined in simple
  742.                 english and does not necessarily reflect the program name used
  743.                 to execute transfers.  The value of this setting will be
  744.                 displayed to the user in the download documentation menu.
  745.  
  746.                 The PROTO command has a single parameter.  The parameter is
  747.                 a single word used to describe the transfer protocol you
  748.                 are supplying.
  749.  
  750.                 Example: PROTO: XModem
  751.                 Default: PROTO: (No protocol downloads supported)
  752.  
  753.                 BATCH: External Transfer Batch Filename
  754.                 ---------------------------------------
  755.                 The BATCH command is used to specify the .BAT file to be
  756.                 executed whenever the user emplys the download documentation
  757.                 feature.
  758.  
  759.                 The batch file is passed the comm port as parameter 1 (%1),
  760.                 and the filename to transfer as parameter 2 (%2).  The batch
  761.                 file MUST also return to the U-Boat main directory before
  762.                 returning back to the program.
  763.  
  764.   ----------------------------------------------------------------------------
  765.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  766.   U-Boat SysOps Documentation - Version 1.00                            Page 9
  767.   ----------------------------------------------------------------------------
  768.  
  769.                 The BATCH command takes a single parameter.  The parameter
  770.                 is the complete drive, path, and filename (including the
  771.                 extention .BAT) of the file to invoke when the players
  772.                 selects the download documentation option.
  773.  
  774.                 Example: BATCH: UBTXFER.BAT
  775.                 Default: BATCH: (No protocol downloads supported)
  776.  
  777.                 EXT1: Documentation Extention #1 (ASCII)
  778.                 ----------------------------------------
  779.                 The EXT1 command takes a single parameter.  The parameter
  780.                 consists of 1 to 3 characters making up the filename exten-
  781.                 tion to the standard ASCII version of the documentation.
  782.  
  783.                 When attempting to display or downlaod the standard docu-
  784.                 mentation, the :DOCS command above defines the drive and
  785.                 path of where to locate the file.  The filename is always
  786.                 'UBOAT' and this extetion is added to yield the complete
  787.                 filename.
  788.  
  789.                 Example: EXT1: ASC
  790.                 Default: EXT1: DOC
  791.  
  792.                 EXT2: Documentation Extention #2 (ASCII Compressed)
  793.                 ---------------------------------------------------
  794.                 The EXT2 command takes a single parameter.  The parameter
  795.                 consists of 1 to 3 characters making up the filename exten-
  796.                 tion to the compressed ASCII version of the documentation.
  797.  
  798.                 When attempting to downlaod the compressed documentation, the
  799.                 :DOCS command above defines the drive and path of where to
  800.                 locate the file.  The filename is always 'UBOAT' and this
  801.                 extetion is added to yield the complete filename.
  802.  
  803.                 Example: EXT2: ZOO
  804.                 Default: EXT2: ZIP
  805.  
  806.                 EXT3: Documentation Extention #3 (PCL-4)
  807.                 ----------------------------------------
  808.                 The EXT3 command takes a single parameter.  The parameter
  809.                 consists of 1 to 3 characters making up the filename exten-
  810.                 tion to the HP+ (PCL-4) compatible version of the documen-
  811.                 tation.
  812.  
  813.                 When attempting to downlaod the PCL-4 version of the docu-
  814.                 mentation, the :DOCS command above defines the drive and
  815.                 path of where to locate the file.  The filename is always
  816.                 'UBOAT-HP' and this extetion is added to yield the complete
  817.                 filename.
  818.  
  819.                 Example: EXT3: HP
  820.                 Default: EXT3: PCL
  821.  
  822.  
  823.   ----------------------------------------------------------------------------
  824.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  825.   U-Boat SysOps Documentation - Version 1.00                           Page 10
  826.   ----------------------------------------------------------------------------
  827.  
  828.                 EXT4: Documentation Extention #4 (PCL-4 Compressed)
  829.                 ---------------------------------------------------
  830.                 The EXT4 command takes a single parameter.  The parameter
  831.                 consists of 1 to 3 characters making up the filename exten-
  832.                 tion to the HP+ (PCL-4) compatible compressed version of the
  833.                 documentation.
  834.  
  835.                 When attempting to downlaod the PCL-4 version of the docu-
  836.                 mentation, the :DOCS command above defines the drive and
  837.                 path of where to locate the file.  The filename is always
  838.                 'UBOAT-HP' and this extetion is added to yield the complete
  839.                 filename.
  840.  
  841.                 Example: EXT4: LZH
  842.                 Default: EXT4: ZIP
  843.  
  844.                 PURGE: Old User Ratings Purge
  845.                 -----------------------------
  846.                 The PURGE command is used to control the deletion of user
  847.                 records from the game files.  The command is provided a
  848.                 single numeric parameter which is the number of days a user
  849.                 can be out of the game without having his records deleted.
  850.                 A value of 0 will disable the automatic user purge feature.
  851.  
  852.                 The single parameter provided can be any value between 0 and
  853.                 32000.
  854.  
  855.                 Example: PURGE: 120
  856.                 Default: PURGE: 90
  857.  
  858.                 RESETS: Automatic Game High Scores Reset
  859.                 ----------------------------------------
  860.                 The RESETS command is used for automatic program restarting.
  861.                 The command is provided a numeric value representing  the
  862.                 number of months between the restting of all game high sco-
  863.                 re.  A value of 0 will disable automatic use of this feature.
  864.  
  865.                 The single parameter provided can be any value between 0 and
  866.                 32000.
  867.  
  868.                 Example: RESETS: 4
  869.                 Default: RESETS: 0
  870.  
  871.                 RESETR: Automatic Game High Scores Reset
  872.                 ----------------------------------------
  873.                 The RESETS command is used for automatic program restarting.
  874.                 The command is provided a numeric value representing  the
  875.                 number of months between the restting of all game high sco-
  876.                 re.  A value of 0 will disable automatic use of this feature.
  877.  
  878.                 The single parameter provided can be any value between 0 and
  879.                 32000.
  880.  
  881.  
  882.   ----------------------------------------------------------------------------
  883.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  884.   U-Boat SysOps Documentation - Version 1.00                           Page 11
  885.   ----------------------------------------------------------------------------
  886.  
  887.                 Example: RESETS: 4
  888.                 Default: RESETS: 0
  889.  
  890.             4.2 The Batch File
  891.             ------------------
  892.             The batch file is used to execute the game from your BBS.  The
  893.             batch file, depending on your BBS software, will either be a stand
  894.             alone batch file or simply a set of commands included in your BBS
  895.             master batch file.  The batch file should change directory to the
  896.             U-Boat main directory, then execute the door using the Standard
  897.             Mycroft command line, then change directory back to the BBS, and
  898.             finally run the BBS if that is required by your BBS software.
  899.             Here is a sample batch file for Spitfire BBS:
  900.  
  901.                 ECHO OFF
  902.                 ECHO ------------
  903.                 ECHO    U-BOAT
  904.                 ECHO ------------
  905.                 CD \DOORS\UBOAT
  906.                 UBOAT 1 C:\SF SPITFIRE
  907.                 CD \SF
  908.  
  909.             The Standard Mycroft Command Line has the following format:
  910.  
  911.                 DOORNAME NODE_ID BBS_PATH BBS_TAG
  912.  
  913.             where the DOORNAME is the name of the .EXE file to run the door,
  914.             the NODE_ID is the numeric ID number of the BBS node executing the
  915.             program (this will always be 1 on single node systems), BBS_PATH is
  916.             the full drive and pathname to your BBS directory, and BBS_TAG is
  917.             the tag identifying which BBS environment you are operating under.
  918.             The following is a list of currently valid BBS tags:
  919.  
  920.                     RBBS            RBBS 16.x and RBBS 17.x
  921.  
  922.                     QBBS            Quick BBS or any other BBS generating a
  923.                                     DORINFOx.DEF file.
  924.  
  925.                     WILDCAT         Wildcat BBS or any other BBS generating a
  926.                                     CALLINFO.BBS file.
  927.  
  928.                     PCBOARD         PC-Board 12.1 or any BBS generating a
  929.                                     compatible PCBOARD.SYS file
  930.  
  931.                     PCBOARD14       PC-Board 14.x or any BBS generating a
  932.                                     compatible PCBOARD.SYS file.
  933.  
  934.                     GAP             GAP BBS or any other BBS generating a
  935.                                     compatible DOOR.SYS file.
  936.  
  937.                     WWIV            WWIV BBS or any other BBS generating a
  938.                                     compatible CHAIN.TXT file.
  939.  
  940.  
  941.   ----------------------------------------------------------------------------
  942.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  943.   U-Boat SysOps Documentation - Version 1.00                           Page 12
  944.   ----------------------------------------------------------------------------
  945.  
  946.                     SPITFIRE        Spitfire BBS or any other BBS generating a
  947.                                     compatible SFDOOR.DAT file.
  948.  
  949.                     SPITFIREK       Spitfire BBS Main Menu command option.
  950.  
  951.                     SPITFIREM       Spitfire BBS Message Menu command option.
  952.  
  953.                     SPITFIREF       Spitfire BBS File Menu command option.
  954.  
  955.             The BBS support file(s), the NODES.BBS file, and optionally the
  956.             PORTS.BBS file are expected to be in the directory pointed to by
  957.             the BBS_PATH parameter of the command line.  See the BBS Support
  958.             files below for exact support filenames.
  959.  
  960.             4.3 Node & Port Files
  961.             ---------------------
  962.             The two files NODES.BBS and PORTS.BBS are support files used by all
  963.             Mycroft Doorware.  Under normal circumstances, these files must be
  964.             located in your BBS directory.  When running under G-Mon, these
  965.             files will need to be located in the same directory as the door
  966.             files.
  967.  
  968.                 NODES.BBS - Node ID File
  969.                 ------------------------
  970.                 The NODES.BBS file is used to associate a serial communications
  971.                 port with each of your BBS nodes.  The file may be from 1 to n
  972.                 lines long.  It is a standard ASCII file containing the names
  973.                 of the comm ports used by each node.  Each line represents the
  974.                 comm port associated with the node associated with that line
  975.                 in the file (ie. line 1 is for node 1, line 2 is for node 2,
  976.                 etc.).
  977.  
  978.                 The value COM0 is used to identify a local only node.
  979.                 Otherwize legal values range from COM1 to COM8.  If you are
  980.                 using anything beyond COM4 you will need to describe the
  981.                 hardware to the program using the facilities in PORTS.BBS.  A
  982.                 sample NODES.BBS file is shown below:
  983.  
  984.                     COM2
  985.                     COM1
  986.                     COM0
  987.                     COM0
  988.  
  989.                 PORTS.BBS - Port ID File
  990.                 ------------------------
  991.                 The PORTS.BBS file is used to describe and control the hardware
  992.                 environment that the door program is to run under.  This file
  993.                 is optional and if not present the IBM defined default hardware
  994.                 settings will be used along with an interrupt driven interface.
  995.  
  996.                 The PORTS.BBS file consists of 1 or more non-comment lines used
  997.                 to define each hardware comm port.  The format for each of
  998.                 these lines is:
  999.  
  1000.   ----------------------------------------------------------------------------
  1001.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1002.   U-Boat SysOps Documentation - Version 1.00                           Page 13
  1003.   ----------------------------------------------------------------------------
  1004.  
  1005.  
  1006.                     PORT ADDR IRQ# INTE HAND PASS
  1007.  
  1008.                 where PORT is the port identifyer and may range from COM1 to
  1009.                 COM8; ADDR is the ports physical base address in hex; IRQ# is
  1010.                 the hardware IRQ number assigned to that port and may range
  1011.                 from IRQ0 to IRQ15; INTE is the interrupt flag and is set to
  1012.                 BIOS for BIOS or Fossil driver support, PORT for direct access,
  1013.                 and INTR for interrupt driven; HAND is the handshaking flag
  1014.                 which may be set to NONE for no handshaking, SOFT for XON/XOFF
  1015.                 handshaking, and BOTH for both types of handshaking; and
  1016.                 finally PASS is the passthru flag which is set to NO to prevent
  1017.                 IRQ passthru, and YES to allow IRQ passthru.
  1018.  
  1019.                 If not provided, then the following defaults are used:
  1020.  
  1021.                     ; PORT   ADDR   IRQ#   INTE   HAND   PASS
  1022.                     ; ---------------------------------------
  1023.                       COM1   03F8   IRQ4   INTR   HARD   NO
  1024.                       COM2   02F8   IRQ3   INTR   HARD   NO
  1025.                       COM3   03E8   IRQ4   INTR   HARD   NO
  1026.                       COM4   02E8   IRQ3   INTR   HARD   NO
  1027.  
  1028.                 It is recommended that you use the default values unless you
  1029.                 have problems or are using COM5 through COM8.  The passthru
  1030.                 should be set to YES if you have more than one device sharing
  1031.                 the IRQ in question.
  1032.  
  1033.             4.4 BBS Support Files
  1034.             ---------------------
  1035.             The following section describes the support files required by each
  1036.             BBS type.  The files should be in the BBS directory as pointed to
  1037.             in the BBS_PATH parameter of the command line.
  1038.  
  1039.                 RBBS Support Files
  1040.                 ------------------
  1041.                 The following files are required or expected under the RBBS
  1042.                 environment:
  1043.  
  1044.                     DORINFOx.DEF    This file contains all of the users
  1045.                                     settings such as graphics, parity, baud
  1046.                                     rate, etc.
  1047.  
  1048.                     NODES.BBS       This file contains a list of which DOS
  1049.                                     device is used for each BBS node.
  1050.  
  1051.                     PORTS.BBS       This file contains a list of the hardware
  1052.                                     environment the program is executed in.
  1053.                                     This file is optional and the IBM standard
  1054.                                     values will be used if this file is not
  1055.                                     found.
  1056.  
  1057.  
  1058.  
  1059.   ----------------------------------------------------------------------------
  1060.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1061.   U-Boat SysOps Documentation - Version 1.00                           Page 14
  1062.   ----------------------------------------------------------------------------
  1063.  
  1064.                 Quick BBS Support Files
  1065.                 -----------------------
  1066.                 The following files are required or expected under the Quick
  1067.                 BBS environment:
  1068.  
  1069.                     DORINFOx.DEF    This file contains all of the users
  1070.                                     settings such as graphics, parity, baud
  1071.                                     rate, etc.
  1072.  
  1073.                     NODES.BBS       This file contains a list of which DOS
  1074.                                     device is used for each BBS node.
  1075.  
  1076.                     PORTS.BBS       This file contains a list of the hardware
  1077.                                     environment the program is executed in.
  1078.                                     This file is optional and the IBM standard
  1079.                                     values will be used if this file is not
  1080.                                     found.
  1081.  
  1082.  
  1083.                 Wildcat Support Files
  1084.                 ---------------------
  1085.                 The following files are required or expected under the Wildcat
  1086.                 BBS environment:
  1087.  
  1088.                     CALLINFO.BBS    This file contains all of the users
  1089.                                     settings such as graphics, parity, baud
  1090.                                     rate, etc.
  1091.  
  1092.                     NODES.BBS       This file contains a list of which DOS
  1093.                                     device is used for each BBS node.
  1094.  
  1095.                     PORTS.BBS       This file contains a list of the hardware
  1096.                                     environment the program is executed in.
  1097.                                     This file is optional and the IBM standard
  1098.                                     values will be used if this file is not
  1099.                                     found.
  1100.  
  1101.  
  1102.                 PC-Board Support Files
  1103.                 ----------------------
  1104.                 The following files are required or expected under the PC-Board
  1105.                 environment:
  1106.  
  1107.                     PCBOARD.SYS     This file contains all of the users
  1108.                                     settings such as graphics, parity, baud
  1109.                                     rate, etc.
  1110.  
  1111.                     NODES.BBS       This file contains a list of which DOS
  1112.                                     device is used for each BBS node.
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118.   ----------------------------------------------------------------------------
  1119.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1120.   U-Boat SysOps Documentation - Version 1.00                           Page 15
  1121.   ----------------------------------------------------------------------------
  1122.  
  1123.                     PORTS.BBS       This file contains a list of the hardware
  1124.                                     environment the program is executed in.
  1125.                                     This file is optional and the IBM standard
  1126.                                     values will be used if this file is not
  1127.                                     found.
  1128.  
  1129.  
  1130.                 GAP Support Files
  1131.                 -----------------
  1132.                 The following files are required or expected under the GAP BBS
  1133.                 environment:
  1134.  
  1135.                     DOOR.SYS        This file contains all of the users
  1136.                                     settings such as graphics, parity, baud
  1137.                                     rate, etc.
  1138.  
  1139.                     NODES.BBS       This file contains a list of which DOS
  1140.                                     device is used for each BBS node.
  1141.  
  1142.                     PORTS.BBS       This file contains a list of the hardware
  1143.                                     environment the program is executed in.
  1144.                                     This file is optional and the IBM standard
  1145.                                     values will be used if this file is not
  1146.                                     found.
  1147.  
  1148.  
  1149.                 WWIV Support Files
  1150.                 ------------------
  1151.                 The following files are required or expected under the WWIV BBS
  1152.                 environment:
  1153.  
  1154.                     CHAIN.TXT       This file contains all of the users
  1155.                                     settings such as graphics, parity, baud
  1156.                                     rate, etc.
  1157.  
  1158.                     NODES.BBS       This file contains a list of which DOS
  1159.                                     device is used for each BBS node.
  1160.  
  1161.                     PORTS.BBS       This file contains a list of the hardware
  1162.                                     environment the program is executed in.
  1163.                                     This file is optional and the IBM standard
  1164.                                     values will be used if this file is not
  1165.                                     found.
  1166.  
  1167.  
  1168.                 Spitfire Support Files
  1169.                 ----------------------
  1170.                 The following files are required or expected under the
  1171.                 Spitfire environment:
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177.   ----------------------------------------------------------------------------
  1178.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1179.   U-Boat SysOps Documentation - Version 1.00                           Page 16
  1180.   ----------------------------------------------------------------------------
  1181.  
  1182.                     SFDOORS.DAT     These files contains all of the users
  1183.                         or          settings such as graphics, parity, baud
  1184.                     SFMAIN.DAT      rate, etc.
  1185.                         or
  1186.                     SFMESS.DAT
  1187.                         or
  1188.                     SFFILE.DAT
  1189.  
  1190.                     NODES.BBS       This file contains a list of which DOS
  1191.                                     device is used for each BBS node.
  1192.  
  1193.                     PORTS.BBS       This file contains a list of the hardware
  1194.                                     environment the program is executed in.
  1195.                                     This file is optional and the IBM standard
  1196.                                     values will be used if this file is not
  1197.                                     found.
  1198.  
  1199.  
  1200.                 G-Mon Support Files
  1201.                 -------------------
  1202.                 G-Mon is the exception to the rule.  The support files when
  1203.                 running under G-Mon must be in the directory with the door
  1204.                 files.  The following files are required under G-Mon:
  1205.  
  1206.                     TIMEOFFx.DOR    This file contains all the directory of the
  1207.                                     monitor and the time controls fro the game
  1208.                                     in progress.
  1209.  
  1210.                     NODES.BBS       This file contains a list of which DOS
  1211.                                     device is used for each BBS node.
  1212.  
  1213.  
  1214.                  The following files are required in the directory specified as
  1215.                  the monitor directory (in TIMEOFFx.DOR):
  1216.  
  1217.                     USERS.DOR       This file contains all of the users
  1218.                                     settings such as graphics, parity, baud
  1219.                                     rate, etc, as well as info pertaining to
  1220.                                     the node.
  1221.  
  1222.                  The following files will be created in the directory specified
  1223.                  as the monitor directory (in TIMEOFFx.DOR) at the time the
  1224.                  door exits:
  1225.  
  1226.                     POINTSx.DOR     This file contains all of the amount of
  1227.                                     time the user spent in Stellar Quest.  It
  1228.                                     also returns the amount of Door Monitor
  1229.                                     points awarded for running the door (this
  1230.                                     is always 0).
  1231.  
  1232.  
  1233.  
  1234.  
  1235.  
  1236.   ----------------------------------------------------------------------------
  1237.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1238.   U-Boat SysOps Documentation - Version 1.00                           Page 17
  1239.   ----------------------------------------------------------------------------
  1240.  
  1241.             4.5 Timegen Utility
  1242.             -------------------
  1243.             Timegen is an optional utility to allow you to add additional time
  1244.             controls to the program.  Timegen allows you to restrict use of the
  1245.             program by security level, time of day, total program entries per
  1246.             day, total time per day, and will also allow you to impose a
  1247.             minimum time between program entries.
  1248.  
  1249.             Timegen will compile a standard ASCII text file into a time control
  1250.             file for use by the program.  The command to execute Timegen is:
  1251.  
  1252.                 TIMEGEN INFILE OUTFILE
  1253.  
  1254.             where INFILE is the ASCII text source file and OUTFILE is the time
  1255.             control file for use by the door program.
  1256.  
  1257.             The source file may not include blank lines nor any comment lines.
  1258.             Each line may however end in a comment starting with a ';'
  1259.             character.  The source file must contain, in the specified order,
  1260.             the following lines: SYSOP, LEVEL, DAYT, DAYG, WAIT, and 1 to 8
  1261.             TIME lines.  The format of each line is described below:
  1262.  
  1263.                 SYSOP - SysOp Paging Hours
  1264.                 --------------------------
  1265.                 The SYSOP command is used to specify the paging hours available
  1266.                 to users when in the program.  The first parameter is the start
  1267.                 time and the second parameter is the stop time.  Each parameter
  1268.                 is in 24 hour HHMM format and may range between 0000 and 2359.
  1269.  
  1270.                 If the start and stop times are identical then paging is
  1271.                 disabled.
  1272.  
  1273.                 Example: SYSOP 1000 2130
  1274.  
  1275.                 LEVEL - Security Level Definitions
  1276.                 ----------------------------------
  1277.                 The LEVEL command is used to define security level groups for
  1278.                 use with the other Timegen functions.  There must be 8 security
  1279.                 groups defined.  Each entry defines the base of the security
  1280.                 group with the cap of the security group being 1 less than the
  1281.                 next entry on the line.  Users with a security level less than
  1282.                 the first security group base will be denied access to the
  1283.                 program.
  1284.  
  1285.                 EXAMPLE: LEVEL 010 020 030 050 070 100 200 500
  1286.  
  1287.                 DAYT - Daily Time Limits
  1288.                 ------------------------
  1289.                 The DAYT command defines the maximum daily time limit for each
  1290.                 of the corresponding security level groups.  This command must
  1291.                 have 8 timelimits each associated to the corresponding security
  1292.                 group.  A value of 0 indicates no time restrictions and any
  1293.                 other value is the daily limit expressed in minutes.
  1294.  
  1295.   ----------------------------------------------------------------------------
  1296.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1297.   U-Boat SysOps Documentation - Version 1.00                           Page 18
  1298.   ----------------------------------------------------------------------------
  1299.  
  1300.                 Example: DAYT 030 045 060 060 060 090 090 000
  1301.  
  1302.                 DAYG - Daily Game Entry Limits
  1303.                 ------------------------------
  1304.                 The DAYG command defines the maximum daily entry limit for each
  1305.                 of the corresponding security level groups.  This command must
  1306.                 have 8 gamelimits each associated to the corresponding security
  1307.                 group.  A value of 0 indicates no maximum game entries and any
  1308.                 other value is the daily limit expressed in number of entries.
  1309.  
  1310.                 Example: DAYG 002 005 005 010 010 010 010 000
  1311.  
  1312.                 WAIT - Wait Times Between Game Entries
  1313.                 --------------------------------------
  1314.                 The WAIT command defines the number of minutes users of each
  1315.                 of the corresponding security level groups must wait between
  1316.                 entries.  8 wait times, each associated to the corresponding
  1317.                 security group, must be specified in the command.  A value of
  1318.                 0 indicates no wait, any other value is the daily wait time
  1319.                 expressed in minutes.
  1320.  
  1321.                 Example: WAIT 030 030 015 015 015 000 000 000
  1322.  
  1323.                 TIME - Max Entry Time Definitions
  1324.                 ---------------------------------
  1325.                 The TIME command defines the maximum time limit per program
  1326.                 entry for each of the corresponding security level groups.
  1327.                 Each TIME command line (from 1 to 8) represents a period during
  1328.                 the day.  The first parameter represents to start of the time
  1329.                 period.  The period is expressed in 24 hour HHMM format and
  1330.                 runs from the time specified to 1 minute less than the next
  1331.                 entry.  TIME command lines must be listed in time ascending
  1332.                 order.  The last TIME command line is assumed to have an ending
  1333.                 time of midnight.
  1334.  
  1335.                 Following the time period base 8 time limits, each associated
  1336.                 to the corresponding security group, must be supplied.  A value
  1337.                 of 0 indicates that access is denied during that time period,
  1338.                 and any other value is the entry limit expressed in minutes.
  1339.  
  1340.                 Example: TIME 0000 060 060 090 090 090 090 090 999
  1341.                          TIME 0630 030 030 045 045 045 045 045 999
  1342.                          TIME 1000 020 020 030 030 030 030 030 999
  1343.                          TIME 1630 000 000 000 000 030 030 030 999
  1344.                          TIME 2330 060 060 090 090 090 090 090 999
  1345.  
  1346.             Note that when Timegen is used, the user receives the minimum
  1347.             amount of time based on: 1) Time remaining on BBS, 2) Time
  1348.             restrictions set by the program, 3) Time restrictions set by
  1349.             Timegen.
  1350.  
  1351.  
  1352.  
  1353.  
  1354.   ----------------------------------------------------------------------------
  1355.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1356.   U-Boat SysOps Documentation - Version 1.00                           Page 19
  1357.   ----------------------------------------------------------------------------
  1358.  
  1359.         5.0 Maintenance Options
  1360.         =======================
  1361.         Maintenance NEED NOT be run everyday.  Bulletins are automatically
  1362.         updated, when needed, at the completion of each game.  The maintenance
  1363.         operations are primarily for deleteing old players and for restarting
  1364.         the high score and high ratings races.
  1365.  
  1366.             5.1 Automatic Maintenance
  1367.             -------------------------
  1368.             Automatic Maintenance is invoked using the following command line:
  1369.  
  1370.                 UBOAT MAINTENANCE
  1371.  
  1372.             When maintenance is run, up to three things may occur depending
  1373.             upon your settings in the configuration menu.  These three include
  1374.             the deletion of players who are inactive, the resetting of all
  1375.             current player ratings, and the resetting of all the game high
  1376.             scores.  Each of these items is controlled through statements in
  1377.             the configuration file.  It is suggested that if any of these
  1378.             options are active, that maintenance be run a minimum of once
  1379.             each month.
  1380.  
  1381.             5.2 Old Player Purging
  1382.             ----------------------
  1383.             Purging old players is a maintenance function designed to limit
  1384.             the amout of space used by U-Boats data files.  It should be run
  1385.             from time to time in order to remove users who are no longer
  1386.             actively playing U-Boat.  The amount of time a user may refrain
  1387.             from playing the game before he is removed is controlled by the
  1388.             configuration file command 'PURGE:'.
  1389.  
  1390.             There are 3 ways in which players may be purged.  The first is
  1391.             through the Automatic Maintenance command line descrivbed above.
  1392.             The second is to simply force a maintenance by typing the above
  1393.             command from the DOS prompt while in the U-Boat directory.  The
  1394.             last is through the editor command 'Purge Old Users'.
  1395.  
  1396.             Note that all of the above mentioned ways make use of the 'PURGE:'
  1397.             configuration file command and will use it's setting.  If it is
  1398.             set to  a value of '0', then user will never be purged.
  1399.  
  1400.             5.3 Resetting Player Ratings
  1401.             ----------------------------
  1402.             The resetting of player ratings will cause the master rating record
  1403.             to be cleared, and all of each players 'current' rating figures
  1404.             to be reset.  Note this noes not effect a players 'all time'
  1405.             rating information.
  1406.  
  1407.             There are six ways that this function can be executed.  The first
  1408.             is through the Automatic Maintenance discribed above.  The second
  1409.             is to manually type the Automatic Maintenance command line from
  1410.             the DOS prompt while in the U-Boat directory.  Both of these
  1411.             methods will check the configuration file command 'RESETR', which
  1412.  
  1413.   ----------------------------------------------------------------------------
  1414.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1415.   U-Boat SysOps Documentation - Version 1.00                           Page 20
  1416.   ----------------------------------------------------------------------------
  1417.  
  1418.             determines the number of months between each ratings reset.
  1419.  
  1420.             The third and fourth methods are through the maintenance command
  1421.             lines:
  1422.  
  1423.                 UBOAT RESETR
  1424.                 UBOAT RESET
  1425.  
  1426.             The first of these will reset only the ratings, while the second
  1427.             will also reset all of the game high scores.  Unlike the first
  1428.             two methods, these commands will have an immediate effect and
  1429.             do NOT pay attention to the configuration file commands.
  1430.  
  1431.             The last two methods are identical to the third and fourth
  1432.             methods, except they are executed from the editor instead of
  1433.             using the command line.  This allows this function to be run
  1434.             remotely if a remote user has editor access.
  1435.  
  1436.             5.4 Resetting Game High Scores
  1437.             ------------------------------
  1438.             The resetting of Game High Scores will cause the master high
  1439.             score record for each game (1-25) to be cleared.  It will also
  1440.             case each player's CURRENT game high scores to be cleared.  This
  1441.             has no effect on the player's 'all time' high scores.
  1442.  
  1443.             There are six ways that this function can be executed.  The first
  1444.             is through the Automatic Maintenance discribed above.  The second
  1445.             is to manually type the Automatic Maintenance command line from
  1446.             the DOS prompt while in the U-Boat directory.  Both of these
  1447.             methods will check the configuration file command 'RESETS', which
  1448.             determines the number of months between each high scores reset.
  1449.  
  1450.             The third and fourth methods are through the maintenance command
  1451.             lines:
  1452.  
  1453.                 UBOAT RESETS
  1454.                 UBOAT RESET
  1455.  
  1456.             The first of these will reset only the game high scores, while
  1457.             the second will also reset all of the game high scores.  Unlike
  1458.             the first two methods, these commands will have an immediate effect
  1459.             and do NOT pay attention to the configuration file commands.
  1460.  
  1461.             The last two methods are identical to the third and fourth
  1462.             methods, except they are executed from the editor instead of
  1463.             using the command line.  This allows this function to be run
  1464.             remotely if a remote user has editor access.
  1465.  
  1466.             5.5 Resetting Full Game
  1467.             -----------------------
  1468.             The resetting of the full game is the combination of the above
  1469.             two commands 'RESETR' and 'RESETS'.  This command, if executed
  1470.             using the MAINTENANCE command line function will only reset
  1471.  
  1472.   ----------------------------------------------------------------------------
  1473.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1474.   U-Boat SysOps Documentation - Version 1.00                           Page 21
  1475.   ----------------------------------------------------------------------------
  1476.  
  1477.             each of the items depending upon their configuration command
  1478.             settings.
  1479.  
  1480.             There are only two methods which guarantee a full game reset.
  1481.             The first is through the DOS command line:
  1482.  
  1483.                 UBOAT RESET
  1484.  
  1485.             The second is the equivalent function executed from inside the
  1486.             game editors.  Note that this function has no effect on players
  1487.             being deleted from the game nor from having their 'all time'
  1488.             high scores reset.
  1489.  
  1490.             Note that all of the maintenance 'RESET?' functions will also
  1491.             cause the bulletins to be updated if either the game high scores
  1492.             or the high ratings are cleared.
  1493.  
  1494.             5.6 Restarting the Game
  1495.             -----------------------
  1496.             If you should desire to completely reset the game, including
  1497.             removing all players and games in progress, then delete all of
  1498.             the .DAT files in the main U-Boat directory.  This can be achieved
  1499.             through the DOS command line:
  1500.  
  1501.                 DEL *.DAT
  1502.  
  1503.             when executed from the main U-Boat directory.  You must then
  1504.             execute the DOS command line:
  1505.  
  1506.                 UBOAT RESET
  1507.  
  1508.             which will cause the master ratings and game scores to be ini-
  1509.             tialized and the bulletins to be cleared.
  1510.  
  1511.  
  1512.  
  1513.  
  1514.  
  1515.  
  1516.  
  1517.  
  1518.  
  1519.  
  1520.  
  1521.  
  1522.  
  1523.  
  1524.  
  1525.  
  1526.  
  1527.  
  1528.  
  1529.  
  1530.  
  1531.   ----------------------------------------------------------------------------
  1532.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1533.   U-Boat SysOps Documentation - Version 1.00                           Page 22
  1534.   ----------------------------------------------------------------------------
  1535.  
  1536.         NOTE: THESE CHAPTER ONLY APPLY TO THE REGISTERED VERSION OF U-BOAT!
  1537.  
  1538.         6.0 Game Editors
  1539.         ================
  1540.         The game editors serve a combination of needs.  The major of these is
  1541.         for ongoing test and debug of the software.  Because of this, many of
  1542.         the editors will allow you to modify almost all of the fields and
  1543.         controls.  Doing this is not recommended as it could change game
  1544.         balance or even cause the game to crash due to invalid conditions.
  1545.         Please be careful when using the editors.
  1546.  
  1547.         A second and more useful use of the editors is to fine tune a new game
  1548.         design.  By "playing around" with the new game maps, the game designer
  1549.         may balance the game between fairness and difficulty level.
  1550.  
  1551.         A third use for the editors is to make small changes and repairs to
  1552.         player and other game records when an error occurs and causes a
  1553.         player to be unable to either enter the game or to play the game.
  1554.         It is hoped this will not be required, but the feature is included
  1555.         just in case.
  1556.  
  1557.         There are four main editors plus the ability to execute maintenance
  1558.         commands that are included in the package.  The editors are: the
  1559.         Player Editor, the Ratings Editor, The High Scores Editor, and the
  1560.         Game in Progress Editor.  Each of these is described below.
  1561.  
  1562.         The editors can be invoked with either of two command lines.  The first
  1563.         format is for running the editor from the local console.  The command
  1564.         line used for this is:
  1565.  
  1566.             UBOAT EDITOR
  1567.  
  1568.         The second command line format is used to run the editors from a remote
  1569.         terminal or computer.  This format is almost identical to the command
  1570.         line used to invoke the game, and it uses the same BBS tags and other
  1571.         parameters.  The command line used to run remotely is:
  1572.  
  1573.             UBOAT NODE_ID BBS_PATH BBS_TAG EDITOR
  1574.  
  1575.         where  NODE_ID is the numeric ID number of the BBS node executing the
  1576.         program (this will always be 1 on single node systems), BBS_PATH is
  1577.         the full drive and pathname to your BBS directory, and BBS_TAG is the
  1578.         tag identifying which BBS environment you are operating under.  The
  1579.         BBS tags are the same as those used to invoke the game.
  1580.  
  1581.         In both of these modes, your user login will be compared to those in
  1582.         the game configuration file to make sure there is a match.  You will
  1583.         also be required to enter the editor password before access to the
  1584.         editors is granted.
  1585.  
  1586.         For users who have editor access, they may also enter the editors
  1587.         from the game's main menu be depressing the 'E' command.  Once again,
  1588.  
  1589.   ----------------------------------------------------------------------------
  1590.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1591.   U-Boat SysOps Documentation - Version 1.00                           Page 23
  1592.   ----------------------------------------------------------------------------
  1593.  
  1594.         the user will be prompted for the editor access password.  Note that
  1595.         the editor password IS case sensative and MAY be more than a single
  1596.         word.
  1597.  
  1598.         You will find that some items displayed in the edit screens are just
  1599.         that.  They are display only.  Allowing change of these would either
  1600.         require extremely complex code or would have major possibilities of
  1601.         corrupting the game.  These fields will be identified by generating
  1602.         a beep when an attempt to edit them is made.
  1603.  
  1604.             6.1 Player Editor
  1605.             -----------------
  1606.             The Player Editor will allow you to examine and modify the
  1607.             records in the player file.  These pertain to the player's
  1608.             personal information (such as login, password, alias, etc),
  1609.             his timing functions (such as amoutn of time played during
  1610.             the day, or number of game entries during the day), as well
  1611.             as his game settings and scoring information.
  1612.  
  1613.                 Selecting Players
  1614.                 -----------------
  1615.                 The top of the Player Editor screen shows the current players
  1616.                 record number and the total number of player records.  You
  1617.                 may jump from player record to player record by using the
  1618.                 PgUp and PgDn keys (with NumLock set of course).  If you
  1619.                 attempt to change player records after modifying a record,
  1620.                 you will be prompted to make sure you wish to change records
  1621.                 AND IGNORE THE CHANGES to the player record.
  1622.  
  1623.                 Player Status
  1624.                 -------------
  1625.                 The Player Status represents the state of the current player
  1626.                 record.  It will contain a '0' value if the record has been
  1627.                 deleted, or will contain the record number if the player is
  1628.                 still active.
  1629.  
  1630.                 As of this version, this field may not be changed.  In a
  1631.                 later version, this may be changed.
  1632.  
  1633.                 This field may contain an integer value '0' or greater.
  1634.  
  1635.                 Active Game
  1636.                 -----------
  1637.                 The Active Game field shows whether or not the player is
  1638.                 currently in the midst of playing a game.  A value of '0'
  1639.                 or 'None' means the player is not actively playing a sce-
  1640.                 nario.  A positive integer indicates the 'Game in Progress'
  1641.                 record number of the scenario that he/she is playing.
  1642.  
  1643.                 This field may contain any integer 0 or larger.  You must
  1644.                 be extremely careful when modifying this field.  If you clear
  1645.                 it from an active game to 0, then you should also clear the
  1646.                 appropriate record in the 'Games in Progress' editor.
  1647.  
  1648.   ----------------------------------------------------------------------------
  1649.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1650.   U-Boat SysOps Documentation - Version 1.00                           Page 24
  1651.   ----------------------------------------------------------------------------
  1652.  
  1653.                 It is completely unadvisable to change this value for 0
  1654.                 (or None) to a positive number.  You will be doing one
  1655.                 of three things (which will all result in disaster).
  1656.                 First, you could be connecting it to a non-existing game
  1657.                 record in which case the player will end up locked out of
  1658.                 the game.  Secondly you could be connecting to a deleted
  1659.                 game record in which case, the results are completely
  1660.                 unknown and could actually cause the code to 'lock up'.
  1661.                 Thirdly, you could be connecting to a game already in
  1662.                 progress that another player is playing, thus creating
  1663.                 problems for both players (again with unpredictable
  1664.                 results).
  1665.  
  1666.                 Player Login
  1667.                 ------------
  1668.                 This field contains the players BBS login name.  Changing
  1669.                 this field will have the effect of disconnecting him/or her
  1670.                 from all previous and any ongoing games and ratings.  This
  1671.                 is not advisable with the exception of if you are going to
  1672.                 allow a user to change his BBS login and he still wants to
  1673.                 continue playing U-Boat where he/she left off.
  1674.  
  1675.                 This field may contain from 1 to 31 characters.
  1676.  
  1677.                 Player Alias
  1678.                 ------------
  1679.                 This field contains the alias the player has chosen to use
  1680.                 in the game.  This field will be used in bulding bulletins
  1681.                 if you have enabled the use of aliasses in the configuration
  1682.                 file.  There is no danger in changing this field.
  1683.  
  1684.                 The field may be 1 to 31 characters in length.
  1685.  
  1686.                 Player Password
  1687.                 ---------------
  1688.                 The player password field contains the players local game
  1689.                 access password.  Changing this field will obviously lock
  1690.                 the player out of the game when the game is played locally.
  1691.                 Under normal circumstances, you will only modify this
  1692.                 field at the players request.
  1693.  
  1694.                 This field is 1 to 31 characters long.  It IS case sensative
  1695.                 and may be more than one word.  It is only used when the
  1696.                 player enter locally.  If the player originally entered the
  1697.                 game through a BBS, then this field will have been set to
  1698.                 'Password'.
  1699.  
  1700.                 Player Ship
  1701.                 -----------
  1702.                 This field contains the the name the player chose for his
  1703.                 ship when he first entered the game.  It is only used when
  1704.                 generating the bulletins.  Normally, you will only change
  1705.                 this field at the players request.
  1706.  
  1707.   ----------------------------------------------------------------------------
  1708.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1709.   U-Boat SysOps Documentation - Version 1.00                           Page 25
  1710.   ----------------------------------------------------------------------------
  1711.  
  1712.                 The field may be from 1 to 31 characters long.
  1713.  
  1714.                 Last Date Played
  1715.                 ----------------
  1716.                 This field shows the last date on which the player in
  1717.                 question entered the game.  The field is an 11 character
  1718.                 alpha numeric field and is expressed as MMM DD YYYY.  The
  1719.                 MMM portion is a 3 character alpha abreviation for the month.
  1720.                 The DD portion is the date of the month with a leading blank
  1721.                 or 0 as required.  The YYYY field is the actual Gregorian
  1722.                 year.  The field may be changed as desired.  Setting it to an
  1723.                 old date will cause a player to be deleted if that player
  1724.                 does not call in before maintenance is run.
  1725.  
  1726.                 This field is updated every time the player enters the game
  1727.                 upon his exit of the program.
  1728.  
  1729.                 Total Time Played
  1730.                 -----------------
  1731.                 This field shows the number of minutes the player in question
  1732.                 has been in the game during the date shown in the last date
  1733.                 played field.  You may want to reset this field, if you are
  1734.                 using the Timegen facility, to allow a player more time
  1735.                 within the program.
  1736.  
  1737.                 This field is a numeric field showing the amount of time
  1738.                 used that date.  The field is reset to 0 when a player enters
  1739.                 the game the first time each day.  It is updated everytime a
  1740.                 player exits the game.
  1741.  
  1742.                 As of this writing, this field is corrupted when a player
  1743.                 enters the game in local mode.  Setting this field back to 0
  1744.                 will correct the problem.
  1745.  
  1746.                 Total Game Entries
  1747.                 ------------------
  1748.                 This field shows the number of game entries of the player in
  1749.                 question on the last date played.  This field is in the range
  1750.                 of 0 to 32000.  The field is set to 0 upon a players first
  1751.                 entry into the game on each new day.  The field is incremen-
  1752.                 ted automatically each time the players exits the game.
  1753.  
  1754.                 Language Setting
  1755.                 ----------------
  1756.                 This field shows the player in questions language choice.
  1757.                 The field is a 3 character alpha-numeric field which repre-
  1758.                 sents the file extention of the message files used in the
  1759.                 game.  This field may be set to any alpha numeric string that
  1760.                 matches one of the language file extentions supported by the
  1761.                 program.  The language extentions will depend on which lan-
  1762.                 guages are available and which language extentions you have
  1763.                 aquired.
  1764.  
  1765.  
  1766.   ----------------------------------------------------------------------------
  1767.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1768.   U-Boat SysOps Documentation - Version 1.00                           Page 26
  1769.   ----------------------------------------------------------------------------
  1770.  
  1771.                 The field is set either automatically or by player choice
  1772.                 when he first enters the game.  It may be changed by the
  1773.                 player, if the multi-lingual option is enabled, anytime the
  1774.                 player is in the game.  Setting this field to an extention
  1775.                 that you don'y have will cause an error when the player
  1776.                 enters the game and will thus prevent him/her from playing.
  1777.  
  1778.                 Graphics Setting
  1779.                 ----------------
  1780.                 This field shows the player in questions graphics setting.
  1781.                 The field is set to either ASCII, IBM, or COLOR to represent
  1782.                 the graphics setting the player has selected.  This field may
  1783.                 be toggled to any of these three values.  This field is
  1784.                 originally set by the player when he first enters the game.
  1785.                 It may be changed by the player at anytime the player is in
  1786.                 the game and selects the appropriate command.
  1787.  
  1788.                 Message Delay Setting
  1789.                 ---------------------
  1790.                 This field shows the player in question's message delay
  1791.                 factor.  The field is set automatically to MODERATE upon a
  1792.                 players original entry into the game.  The player may then
  1793.                 update the field whenever he/she is in the game.  The field
  1794.                 may be toggled to any of its settings.
  1795.  
  1796.                 Current Games Total
  1797.                 -------------------
  1798.                 This field contains the total number of games the player has
  1799.                 completed since the last time the game ratings were reset.
  1800.                 The field is incremented each time the player wins a game.
  1801.                 It is used to calculate the players current rating at the
  1802.                 end of each game.
  1803.  
  1804.                 This field is a numeric field and may be set to any number
  1805.                 0 or larger.  The field is automatically reset to 0 whenever
  1806.                 the game ratings are reset.
  1807.  
  1808.                 Current Score Total
  1809.                 -------------------
  1810.                 This field contains the total number of points a player has
  1811.                 accumulated since the last time the player ratings were
  1812.                 reset.  The field is updated ecery time the player completes
  1813.                 a game and is used to calculate the player rating.
  1814.  
  1815.                 This field may be set to any number greater than or equal
  1816.                 to 0.  It is automatically reset to 0 whenever tha player
  1817.                 ratings are reset.
  1818.  
  1819.                 Current Rating
  1820.                 --------------
  1821.                 This field contains the players current rating.  It reflects
  1822.                 his/her current score total divided by his/her current games
  1823.                 total.  The field is set each time the player completes a
  1824.  
  1825.   ----------------------------------------------------------------------------
  1826.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1827.   U-Boat SysOps Documentation - Version 1.00                           Page 27
  1828.   ----------------------------------------------------------------------------
  1829.  
  1830.                 game.  Changing this field will have no effect since it is
  1831.                 set each time before it is used.
  1832.  
  1833.                 The field may contain any number greater than or equal to
  1834.                 0.
  1835.  
  1836.                 All Time Games Total
  1837.                 --------------------
  1838.                 This field contains the total number of games the player has
  1839.                 completed since the first time he/she played.  It is used to
  1840.                 derive his all time rating.  The field is initally set to 0
  1841.                 and is incremented by 1 each time the player completes a
  1842.                 game.
  1843.  
  1844.                 This field is a numeric field and may be set to any number
  1845.                 0 or larger.
  1846.  
  1847.                 All Time Score Total
  1848.                 --------------------
  1849.                 This field contains the total number of points a player has
  1850.                 accumulated since he/she first played.  The field is initia-
  1851.                 lized to 0 and then updated each time the player completes a
  1852.                 game.  It is used to calculate the player all time rating.
  1853.  
  1854.                 This field may be set to any number greater than or equal
  1855.                 to 0.
  1856.  
  1857.                 All Time High Rating
  1858.                 --------------------
  1859.                 This field contains the players best rating since he/she
  1860.                 started playing the game.  It is updated at the end of each
  1861.                 game if the players new current rating is higher than this
  1862.                 field.
  1863.  
  1864.                 This numeric field can be set to any number greater than or
  1865.                 equal to 0.
  1866.  
  1867.                 Edit Current High Scores
  1868.                 ------------------------
  1869.                 This menu entry takes you to a sub menu that shows the
  1870.                 player's current high scores, and the date they earned the
  1871.                 score, for each of the 25 game scenarios.  The high scores
  1872.                 are reset each time the reset high scores maintenance func-
  1873.                 tion is run.
  1874.  
  1875.                 The score fields may be any number 0 or larger.  The date
  1876.                 fields are in standard MMM DD YYYY format.
  1877.  
  1878.                 Edit All Time High Scores
  1879.                 -------------------------
  1880.                 This menu entry takes you to a sub menu that shows the
  1881.                 player's all time high scores, and the date they earned the
  1882.                 score, for each of the 25 game scenarios.  The high scores
  1883.  
  1884.   ----------------------------------------------------------------------------
  1885.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1886.   U-Boat SysOps Documentation - Version 1.00                           Page 28
  1887.   ----------------------------------------------------------------------------
  1888.  
  1889.                 are initially set to 0 the first time a player enters the
  1890.                 game.  They are updated each time the player completes a
  1891.                 game and has achieved a higher score than the current value.
  1892.  
  1893.                 The score fields may be any number 0 or larger.  The date
  1894.                 fields are in standard MMM DD YYYY format.
  1895.  
  1896.                 Save Player
  1897.                 -----------
  1898.                 This menu entry will write the current player record back
  1899.                 to the player file and thus make the changes permanent.  As
  1900.                 a safety guard, you will be prompted if you attempt to
  1901.                 change player record or exit the player editor without
  1902.                 first writing the record back to the player file.
  1903.  
  1904.                 Exit Player Editor
  1905.                 ------------------
  1906.                 This menu entry will ext the player editor and return back
  1907.                 to the main editor menu.  As mentioned above, you will be
  1908.                 prompted if you attempt to exit the editor and have not
  1909.                 saved your changes to the current player record.
  1910.  
  1911.             6.2 Ratings Editor
  1912.             ==================
  1913.             The ratings editor is used to change the master ratings record.
  1914.             The master rating record is used to generate the top 10 rated
  1915.             players bulletin.  The record is completely reset each time a
  1916.             ratings reset is executed.
  1917.  
  1918.                 Editing Player Ratings
  1919.                 ----------------------
  1920.                 The top 10 players are listed with either their name or
  1921.                 their alias, their ship's name, their rating, the total
  1922.                 current games played, and the date they last completed a
  1923.                 game.  When you select an entry, you will be prompted
  1924.                 for each of these items.  The entire list is cleared
  1925.                 whenever you execute a player ratings reset.
  1926.  
  1927.                 The name and ship name fields may each be from 1 to 31
  1928.                 characters.  The rating and total games fields may be
  1929.                 set to any positive number.  The date field is in standard
  1930.                 MMM DD YYYY format.
  1931.  
  1932.                 Changing Last Reset Date
  1933.                 ------------------------
  1934.                 The last reset date field contains the date when a reset
  1935.                 player ratings command was executed.  Changing this field
  1936.                 to a date prior to the current setting will speed up the
  1937.                 next reset if you have automatic maintenance enabled and
  1938.                 the configuration command RESETR: is non zero.  Setting
  1939.                 the date to a date beyond the current date will produce
  1940.                 unpredictable results.
  1941.  
  1942.  
  1943.   ----------------------------------------------------------------------------
  1944.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  1945.   U-Boat SysOps Documentation - Version 1.00                           Page 29
  1946.   ----------------------------------------------------------------------------
  1947.  
  1948.                 This field is stored in standard MMM DD YYYY format.
  1949.  
  1950.                 Saving Rating Information
  1951.                 -------------------------
  1952.                 Selecting the 'save and exit' menu entry will write the
  1953.                 master ratings record back to the ratings file and return
  1954.                 back to the main editor menu.
  1955.  
  1956.                 Discarding Rating Information
  1957.                 -----------------------------
  1958.                 Selecting the 'discard and exit' menu entry will discard
  1959.                 the changes you have made, and return back to the main
  1960.                 editor menu.
  1961.  
  1962.             6.3 High Scores Editor
  1963.             ----------------------
  1964.             The high scores editor will allow you to examine and modify
  1965.             the top two players for each of the 25 game scenarios.  All
  1966.             of the high score information is cleared whenever you execute
  1967.             a reset high scores function.
  1968.  
  1969.                 1st and 2nd Place Player Information
  1970.                 ------------------------------------
  1971.                 For each of the 25 game scenarios, the information on
  1972.                 the two players who hold the highest scores will be shown.
  1973.                 The 1st place player information will be displayed on the
  1974.                 left side of the screen while the 2nd place player informa-
  1975.                 tion will be displayed on the right side of the screen.
  1976.  
  1977.                 Players Name/Alias
  1978.                 ------------------
  1979.                 This field will show the players name or alias (depending
  1980.                 on the setting of the configuration file command ALIAS:).
  1981.                 Changing this field will not effect the game itself, but
  1982.                 will change the results in the Game High Scores bulletins.
  1983.  
  1984.                 This field may contain from 0 to 31 characters.
  1985.  
  1986.                 Players Ship Name
  1987.                 -----------------
  1988.                 This field contains the name of the associated players
  1989.                 ship as shown in the Game High Scores bulletins (It does
  1990.                 not change the name of the players ship).
  1991.  
  1992.                 This field may contain from 0 to 31 characters.
  1993.  
  1994.                 Players Score
  1995.                 -------------
  1996.                 This field shows the high score achieved by the associated
  1997.                 player for the game in question.  Changing it will effect
  1998.                 the Game High Scores bulletins the next time they are
  1999.                 generated.
  2000.  
  2001.  
  2002.   ----------------------------------------------------------------------------
  2003.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2004.   U-Boat SysOps Documentation - Version 1.00                           Page 30
  2005.   ----------------------------------------------------------------------------
  2006.  
  2007.                 This field may contain any positive number.
  2008.  
  2009.                 Date Game Was Played
  2010.                 --------------------
  2011.                 This field shows the date the game played by the associated
  2012.                 player was completed.  Changing this field will have no
  2013.                 effect on the game.  It may however show in the bulletins
  2014.                 the next time bulletins are generated.
  2015.  
  2016.                 This field is in standard MMM DD YYYY format.
  2017.  
  2018.                 Changing Last Reset Date
  2019.                 ------------------------
  2020.                 The last reset date field contains the date when a reset
  2021.                 game high scores command was executed.  Changing this field
  2022.                 to a date prior to the current setting will speed up the
  2023.                 next reset if you have automatic maintenance enabled and
  2024.                 the configuration command RESETS: is non zero.  Setting
  2025.                 the date to a date beyond the current date will produce
  2026.                 unpredictable results.
  2027.  
  2028.                 This field is in standard MMM DD YYYY format.
  2029.  
  2030.                 Previous Game Information
  2031.                 -------------------------
  2032.                 Selecting this menu item will change the editor from the
  2033.                 current game record to the previous game record.  If you
  2034.                 have modified the current record, you will be prompted before
  2035.                 the change is made.
  2036.  
  2037.                 Next Game Information
  2038.                 ---------------------
  2039.                 Selecting this menu item will change the editor from the
  2040.                 current game record to the next game record.  If you have
  2041.                 modified the current record, you will be prompted before
  2042.                 the change is made.
  2043.  
  2044.                 Saving High Scores
  2045.                 ------------------
  2046.                 Selecting this menu item will cause all changes made to the
  2047.                 current high scores record to be written back to the ratings
  2048.                 file.  As a safetyguard, if you attempt to change game score
  2049.                 records or exit the high scores editor, you will be prompted
  2050.                 to guarantee that you don't accidentally lose your updated
  2051.                 information.
  2052.  
  2053.                 Exiting High Scores Editor
  2054.                 --------------------------
  2055.                 Selecting this menu item will exit the high scores editor
  2056.                 and return you to the main editor menu.  If you have made
  2057.                 changes to the current game high scores and have not saved
  2058.                 them, you will be prompted to make sure you want to exit.
  2059.  
  2060.  
  2061.   ----------------------------------------------------------------------------
  2062.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2063.   U-Boat SysOps Documentation - Version 1.00                           Page 31
  2064.   ----------------------------------------------------------------------------
  2065.  
  2066.             6.4 Games in Progress Editor
  2067.             ----------------------------
  2068.             This editor will allow you to view and modify all aspects of a
  2069.             game in progress.  The editor was primarily designed as a debug
  2070.             tool, so for the most part you will not need to use it.  In the
  2071.             event you do use it, all of the game fields are described below:
  2072.  
  2073.                 Changing Games
  2074.                 --------------
  2075.                 Near the top of the screen you will find the current game
  2076.                 record number as well as the total number of game records.
  2077.                 Use the PgUp and PgDn keys (with NumLock set) to switch to
  2078.                 the previous or next game record.  If you have modified the
  2079.                 current game record, you will be prompted to make sure you
  2080.                 want to switch records and discard the changes before the
  2081.                 record is changed.
  2082.  
  2083.                 Game Number
  2084.                 -----------
  2085.                 This field indicates the game scenario that is being played.
  2086.                 Scenarios 1 through 5 are built into the program, while sce-
  2087.                 narios 6 through 25 are supported as external scenarios (see
  2088.                 chapter 7).  Changing this field will have disasterous effects
  2089.                 as it may place ships or bases on land thus preventing the
  2090.                 ships from moving, and preventing ships from getting to the
  2091.                 bases.  The field is set to 0 to release the game in progress
  2092.                 record for reuse.
  2093.  
  2094.                 If you disconnect a player from a game in the player editor,
  2095.                 then you should also clear the game record in this editor.
  2096.                 This will be done automatically in a future version.
  2097.  
  2098.                 The numeric field may contain any number between 0 and 25.
  2099.  
  2100.                 Game Turn
  2101.                 ---------
  2102.                 This field contains the game turn.  The field has no conse-
  2103.                 quence on the game except for marking the passage of time;
  2104.                 therefore changing this field will have no effect.
  2105.  
  2106.                 This numeric field may contain any positive number.
  2107.  
  2108.                 Game Score
  2109.                 ----------
  2110.                 This field shows the number of points the player has scored
  2111.                 so far in the game.  Changing the field will have the obvious
  2112.                 effect of changing his/her eventual game score.
  2113.  
  2114.                 This numeric field may contain any number greater than or
  2115.                 equal to 0.
  2116.  
  2117.  
  2118.  
  2119.  
  2120.   ----------------------------------------------------------------------------
  2121.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2122.   U-Boat SysOps Documentation - Version 1.00                           Page 32
  2123.   ----------------------------------------------------------------------------
  2124.  
  2125.                 Sub Bases
  2126.                 ---------
  2127.                 Selecting this menu entry will take you to the Sub Bases
  2128.                 sub-menu (no pun intended).  In this menu, you will see the
  2129.                 positions of all of the sub bases.  There may be from 1 to
  2130.                 32 active sub bases.  The greater the number of bases, the
  2131.                 greater the randomness of where new subs will appear.
  2132.  
  2133.                 Each field contains the Y and X coordinates of the base.
  2134.                 The Y coordinate must be in the range of 1 to 17.  The X
  2135.                 coordinate must be in the range of 1 to 49.  If you move
  2136.                 or create bases, make sure you don't place them on land as
  2137.                 this will cripple the game.  Any changes you make effect
  2138.                 this game only and not the scenario as a whole.
  2139.  
  2140.                 Destroyer Bases
  2141.                 ---------------
  2142.                 Selecting this menu entry will take you to the Destroyer
  2143.                 Bases sub-menu.  In this menu, you will see the positions of
  2144.                 all of the destroyer bases.  There may be from 1 to 4 active
  2145.                 destroyer bases.  The greater the number of bases, the easier
  2146.                 the game will be to play.
  2147.  
  2148.                 Each field contains the Y and X coordinates of the base.
  2149.                 The Y coordinate must be in the range of 1 to 17.  The X
  2150.                 coordinate must be in the range of 1 to 49.  If you move
  2151.                 or create bases, make sure you don't place them on land as
  2152.                 this will cripple the game.  Any changes you make effect
  2153.                 this game only and not the scenario as a whole.
  2154.  
  2155.                 Transport Ports
  2156.                 ---------------
  2157.                 Selecting this menu entry will take you to the Transport
  2158.                 Ports sub-menu.  In this menu, you will see the positions of
  2159.                 all of the transport ports.  There may be from 1 to 4 active
  2160.                 transport ports.  The greater the number of ports, the easier
  2161.                 the game will be to play.
  2162.  
  2163.                 Each field contains the Y and X coordinates of the port.
  2164.                 The Y coordinate must be in the range of 1 to 17.  The X
  2165.                 coordinate must be in the range of 1 to 49.  If you move
  2166.                 or create ports, make sure you don't place them on land as
  2167.                 this will cripple the game.  Any changes you make effect
  2168.                 this game only and not the scenario as a whole.
  2169.  
  2170.                 Sub Status
  2171.                 ----------
  2172.                 This field shows the current status of the U-boat.  After
  2173.                 a U-boat is destroyed, it is randomly set to one of the
  2174.                 destroyed status values.  It must then progress through the
  2175.                 stages until it is once again deployed.  At that time a
  2176.                 sub base will be chosen at random and the U-boat set to that
  2177.                 position.
  2178.  
  2179.   ----------------------------------------------------------------------------
  2180.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2181.   U-Boat SysOps Documentation - Version 1.00                           Page 33
  2182.   ----------------------------------------------------------------------------
  2183.  
  2184.                 This field is a toggle field and may be toggled to any value.
  2185.  
  2186.                 Destroyer Fuel
  2187.                 --------------
  2188.                 This field shows the amount of fuel the destroyer has.  The
  2189.                 destroyer starts off with 56 units of fuel and expends one
  2190.                 unit of fuel in each turn in which the destroyer moves.  The
  2191.                 fuel is reset back to 56 whenever the detroyer enters a
  2192.                 destroyer base.
  2193.  
  2194.                 This numeric field may contain any number in the range of 0
  2195.                 through 56.
  2196.  
  2197.                 Destroyer Depth Charges
  2198.                 -----------------------
  2199.                 This field shows the number of depth charge sets the destro-
  2200.                 yer has remaining.  The destroyer starts of with 11 sets of
  2201.                 charges, and expends one set for each depth charge attack.
  2202.                 The field is rest back to 11 whenever the destroyer enters
  2203.                 a destroyer base.
  2204.  
  2205.                 This numeric field may contain any number in the range of 0
  2206.                 through 11.
  2207.  
  2208.                 Transport Launch Period
  2209.                 -----------------------
  2210.                 This field shows the number of turns that must pass between
  2211.                 the time a transport is ready to be launched and when it is
  2212.                 launched.  The field is set to 3 after each transport launch.
  2213.  
  2214.                 This numeric field may contain any number in the range of 1
  2215.                 through 3.
  2216.  
  2217.                 Unlaunched Transports
  2218.                 ---------------------
  2219.                 This field shows the number of transports that are still
  2220.                 waiting to be launched.  Changing this field will obviously
  2221.                 either shorten or lengthen the game.  Each game scenario
  2222.                 starts with 16 unlaunched transports.
  2223.  
  2224.                 This numeric field may contain any number in the range of
  2225.                 0 through 16.
  2226.  
  2227.                 Transports At Sea
  2228.                 -----------------
  2229.                 Selecting this menu entry will take you to the Transports
  2230.                 At Sea sub menu.  The menu will shown the locations of all
  2231.                 transports currently at see.  There may be up to 4 transports
  2232.                 at sea at any one time.  Be extremely careful if you move
  2233.                 or create a transport at sea that you do not move it to
  2234.                 a location surrounded by land or the transport will never
  2235.                 move and the game will therefore never end.
  2236.  
  2237.  
  2238.   ----------------------------------------------------------------------------
  2239.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2240.   U-Boat SysOps Documentation - Version 1.00                           Page 34
  2241.   ----------------------------------------------------------------------------
  2242.  
  2243.                 Each transports location is show as it's Y and X coordinates.
  2244.                 The Y coordinates must be in the range of 1 to 17 and the X
  2245.                 coordinates must be in the range of 1 to 49.
  2246.  
  2247.                 Transport Missions Completed
  2248.                 ----------------------------
  2249.                 This field shows the number of successful transport missions
  2250.                 thus far in the game scenario.  This field is initially set
  2251.                 to 0 and is then incremented by 1 each time a transport arri-
  2252.                 ves safely at a port.  At the end of the game, this field is
  2253.                 tested to see if all missions were successful and if so, the
  2254.                 safe transport bonus is granted to the user.  Changing this
  2255.                 field will have the obvious effect of lessening or increa-
  2256.                 sing the players chance to get the bonus.
  2257.  
  2258.                 This numeric field may contain any number in the range of 0
  2259.                 through 16.
  2260.  
  2261.                 Transport Completion Points
  2262.                 ---------------------------
  2263.                 This field shows the amount of points that will be awarded
  2264.                 for the next transport that successfully arrives at a port.
  2265.                 The field is initially set to 250 and is incremented by 50
  2266.                 each time a transport arrives in port.  Changing this field
  2267.                 will have the obvious effect of changing the players final
  2268.                 score.
  2269.  
  2270.                 This numeric field may be set to any multiple of 50.
  2271.  
  2272.                 Saving Game Information
  2273.                 -----------------------
  2274.                 Selecting this menu entry will cause all current changes to
  2275.                 be written back to the game in progress record.  As a safety
  2276.                 precaution, attempting to change the current game record or
  2277.                 to exit the game in progress editor without first saving the
  2278.                 game information will cause a prompt to be displayed asking
  2279.                 if you are sure you want to discard the information.
  2280.  
  2281.                 Exiting Game Editor
  2282.                 -------------------
  2283.                 Selecting this menu entry will exit the games in progress
  2284.                 editor and return to the main editor menu.  In the event
  2285.                 that current game information has been changed but not saved,
  2286.                 a prompt will be displayed asking if you are sure you want
  2287.                 to discard the information.
  2288.  
  2289.             6.5 Resetting High Scores
  2290.             -------------------------
  2291.             This feature will allow you to reset all current high scores.
  2292.             The configuration file command 'RESETS:' will be ignored, and
  2293.             all current high scores will be immediately reset and the
  2294.             bulletins rebuilt.
  2295.  
  2296.  
  2297.   ----------------------------------------------------------------------------
  2298.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2299.   U-Boat SysOps Documentation - Version 1.00                           Page 35
  2300.   ----------------------------------------------------------------------------
  2301.  
  2302.             6.6 Resetting Player Ratings
  2303.             ----------------------------
  2304.             This feature will enable you to reset all of the current player
  2305.             ratings.  The configuration file command 'RESETR:' will be
  2306.             ignored, and all of the current player ratings will be immediatly
  2307.             cleared, and the bulletins will be rebuilt.
  2308.  
  2309.             6.7 Resetting Full Game
  2310.             -----------------------
  2311.             This feature is a combination of the above two features.
  2312.  
  2313.             6.8 Purging Old Users
  2314.             ---------------------
  2315.             This feature will cause the player file to be scanned and all
  2316.             users who have not entered the game for more days than that
  2317.             specified by the configuration file command 'PURGE:' will be
  2318.             freed.
  2319.  
  2320.             6.9 Reviewing Program Error Log
  2321.             -------------------------------
  2322.             This feature will allow you to review the program error log.
  2323.             under normal circumstances you should not have anything in the
  2324.             error log other than the warning that it is creating the games
  2325.             in progress error.  If you do encounter other errors that you
  2326.             cannot understand or feel should not have occured, please con-
  2327.             tact the Mycroft Systems voice help line.
  2328.  
  2329.             After you have reviewed the error log, you will be prompted to
  2330.             see if you want to delete it.
  2331.  
  2332.             6.10 Exiting the Editor
  2333.             -----------------------
  2334.             This feature is used to exit the editor.  If the editor was
  2335.             directly entered then you will be returned to DOS or the BBS
  2336.             depending on how you entered.  Otherwise you will be returned
  2337.             to the U-Boat Main Menu.
  2338.  
  2339.  
  2340.  
  2341.  
  2342.  
  2343.  
  2344.  
  2345.  
  2346.  
  2347.  
  2348.  
  2349.  
  2350.  
  2351.  
  2352.  
  2353.  
  2354.  
  2355.  
  2356.   ----------------------------------------------------------------------------
  2357.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2358.   U-Boat SysOps Documentation - Version 1.00                           Page 36
  2359.   ----------------------------------------------------------------------------
  2360.  
  2361.         NOTE: THESE CHAPTER ONLY APPLY TO THE REGISTERED VERSION OF U-BOAT!
  2362.  
  2363.         7.0 Creating Additional Game Scenarios
  2364.         ======================================
  2365.         The registered version of U-Boat will support 20 additional game
  2366.         scenarios.  These scenarios are defined as external files named
  2367.         UBOAT-nn.MAP where the nn represents a number between 06 and 25.
  2368.         Each scenario has a fixed format and is described below.
  2369.  
  2370.             7.1 Maximum Scenario Support
  2371.             ----------------------------
  2372.             As mentioned above, the shareware version of the software sup-
  2373.             ports 5 built-in game scenarios.  The registered version supports
  2374.             the same 5 built in screnarios plus up to 20 external scenarios.
  2375.  
  2376.             7.2 Map File Format
  2377.             -------------------
  2378.             The first line of the map file is used to contain the scenario
  2379.             title.  The title is limited to a maximum of 16 characters.
  2380.             The remainder of the file consists of 19 lines of 51 characters
  2381.             which are used to define the game scenario map.  The first and
  2382.             last lines and the first and last columns must be defined as
  2383.             land.  The remainder of the map may be setup in any arrangement
  2384.             provided you do not build routes that may trap the transports.
  2385.  
  2386.             Transports may only move north, south, or east (with the excep-
  2387.             tion of sea lanes (see below)), so you you must take care NOT
  2388.             to generate a route that they cannot escape from.  A sample
  2389.             external scenario is provided in the file UBOAT-06.MAP.
  2390.  
  2391.             The following sections describe the various items that may be
  2392.             used to build a map:
  2393.  
  2394.                 [ ] Seas
  2395.                 --------
  2396.                 Seas are the normal terrain of the game.  All types of ships
  2397.                 may maneuver through sea locations.
  2398.  
  2399.                 [#] Land
  2400.                 --------
  2401.                 Land locations are off limit to all types of ships.  Use the
  2402.                 land locations to generate a variety of islands and peninsu-
  2403.                 las to provide the transports a variety of routes to follow
  2404.                 to their target port(s).  As mentioned above, it is required
  2405.                 that the 1st and last lines and 1st and last columns of the
  2406.                 map be land locations.  These locations are not displayed to
  2407.                 the user and are just to support the movement logic in the
  2408.                 game to prevent ships from sailing off the edge of the map.
  2409.  
  2410.                 [C] Transport Base
  2411.                 ------------------
  2412.                 There may only be 1 transport base.  The transport base is
  2413.                 the location that all transports will be launched from.  It
  2414.  
  2415.   ----------------------------------------------------------------------------
  2416.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2417.   U-Boat SysOps Documentation - Version 1.00                           Page 37
  2418.   ----------------------------------------------------------------------------
  2419.  
  2420.                 is off limits for all ship types to enter the transport base.
  2421.                 The base should be located on the western edge of the map
  2422.                 since the transports move primarily eastward.  The base
  2423.                 should not be located too close to any sub bases.
  2424.  
  2425.                 [T] Transport Ports
  2426.                 -------------------
  2427.                 You may define up to 4 transport ports.  These are the tar-
  2428.                 get locations that the transports must reach to complete
  2429.                 their journeys.  Transport ports may only be entered by
  2430.                 transports.  These ports should be located at the eastern
  2431.                 edge of the map (for reasons explained above).  They should
  2432.                 not be placed too close to a sub base.
  2433.  
  2434.                 [D] Destroyer Bases
  2435.                 -------------------
  2436.                 You may define up to 4 destroyer bases.  These can be placed
  2437.                 anywhere on the map.  Their number and locations will greatly
  2438.                 effect the difficulty of the scenario.  Destroyer bases may
  2439.                 only be entered by destroyers.
  2440.  
  2441.                 [S] U-Boat Bases
  2442.                 ----------------
  2443.                 U-Boat bases, also refered to as sub bases may be placed in
  2444.                 any location on the map.  There must be at least one base
  2445.                 and there is a maximum of 32.  It is suggested that these
  2446.                 bases be located along the northern and southern edges of
  2447.                 the map.  It is also recommended that the bases be spread
  2448.                 out to provide a good random U-boat deployment.  Also, do
  2449.                 not locate sub bases too close to the tarnsport base or the
  2450.                 transport ports.  Sub bases are not displayed on the map
  2451.                 and are thus invisible to the player.  Sub bases may be en-
  2452.                 tered by all ship types.
  2453.  
  2454.                 [nsew] Sea Lanes
  2455.                 ----------------
  2456.                 Sea lanes are one of the most important features in U-Boat.
  2457.                 If left alone to move about completely at random, the trans-
  2458.                 ports would take forever to reach their destinations and may
  2459.                 also get 'clogged up' together in certain areas making them
  2460.                 easy prey as a group for U-boats.  When a transport starts
  2461.                 it's turn in a sea lane location, it will automatically
  2462.                 move the direction indicated by the sea lane (n=north,
  2463.                 s=south, e=east, and w=west).  It is important to use sea
  2464.                 lanes around the transport base so that the transports don't
  2465.                 get all 'clogged up' when starting, around transport ports
  2466.                 to guide them in as quickly and as efficiently as possible,
  2467.                 and in areas of the map where they are likely to get stuck.
  2468.  
  2469.                 Overuse of sea lanes can be equally disasterous by making the
  2470.                 scenario too easy.
  2471.  
  2472.  
  2473.  
  2474.   ----------------------------------------------------------------------------
  2475.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2476.   U-Boat SysOps Documentation - Version 1.00                           Page 38
  2477.   ----------------------------------------------------------------------------
  2478.  
  2479.         8.0 Notes from the Author
  2480.         =========================
  2481.         As many of you know, Mycroft Systems has produced quite a string of
  2482.         door games and utilities.  We strive to produce quality programs and
  2483.         to support them as best we can.
  2484.  
  2485.         U-Boat is meant to follow in that tradition.  Using a new message
  2486.         control system, U-Boat is on of our first doors designed to support
  2487.         a multitude of human languages.  This feature will hopefully be
  2488.         reproduced in all future doors and be slowly retro-fitted into our
  2489.         existing doors.
  2490.  
  2491.         We have also, as with a few of our previous doors, attempted to make
  2492.         the documentation available from within the program.  With U-Boat we
  2493.         are taking the further step of adding a complete online help system.
  2494.         This we also hope to provide in our future offerings.
  2495.  
  2496.         As with following our policies, U-Boat is designed to be an enjoya-
  2497.         ble program with an attractive user interface that is easy to run
  2498.         and install.  If we have failed in any way, we would love to here
  2499.         from you in the form of either letters or comments.
  2500.  
  2501.  
  2502.                                   Michael W. Bayley
  2503.                                   Mycroft Systems
  2504.                                   P.O Box 7672
  2505.                                   San Jose, CA. 95150
  2506.                                   BBS: (408)927-0105
  2507.  
  2508.  
  2509.  
  2510.  
  2511.  
  2512.  
  2513.  
  2514.  
  2515.  
  2516.  
  2517.  
  2518.  
  2519.  
  2520.  
  2521.  
  2522.  
  2523.  
  2524.  
  2525.  
  2526.  
  2527.  
  2528.  
  2529.  
  2530.  
  2531.  
  2532.  
  2533.   ----------------------------------------------------------------------------
  2534.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2535.   U-Boat SysOps Documentation - Version 1.00                          Page A.1
  2536.   ----------------------------------------------------------------------------
  2537.  
  2538.         A.0 Registration Information
  2539.         ============================
  2540.         You are encouraged to register your copy of U-Boat.  Upon doing so
  2541.         you will be mailed the latest version of the program.  The version that
  2542.         you receive will be the commercial version with the editors enabled and
  2543.         all of the other restrictions removed.
  2544.  
  2545.         To register, please fill out the order form in the file ORDER.TXT in
  2546.         the docs subdirectory.  You can register this door only or you can
  2547.         take advantage of one of our package deals which provide substantial
  2548.         discounts.
  2549.  
  2550.         The registration fee for U-Boat is $10 US plus tax in applicable loca-
  2551.         tions.  Also a $2 shipping and handling fee must be included to cover
  2552.         our costs for diskettes, mailers, and postage.  Your order will be
  2553.         promptly processed.
  2554.  
  2555.  
  2556.  
  2557.  
  2558.  
  2559.  
  2560.  
  2561.  
  2562.  
  2563.  
  2564.  
  2565.  
  2566.  
  2567.  
  2568.  
  2569.  
  2570.  
  2571.  
  2572.  
  2573.  
  2574.  
  2575.  
  2576.  
  2577.  
  2578.  
  2579.  
  2580.  
  2581.  
  2582.  
  2583.  
  2584.  
  2585.  
  2586.  
  2587.  
  2588.  
  2589.  
  2590.  
  2591.  
  2592.   ----------------------------------------------------------------------------
  2593.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2594.   U-Boat SysOps Documentation - Version 1.00                          Page B.1
  2595.   ----------------------------------------------------------------------------
  2596.  
  2597.         B.0 List of Files
  2598.         =================
  2599.         U-Boat files fall into 4 types.  These file types are assigned to
  2600.         various subdirectories.  Each type of file is described here in
  2601.         detail.
  2602.  
  2603.             B.1 Documentation Files
  2604.             -----------------------
  2605.             The documentation files are those files to support the SysOp in
  2606.             setting up and maintaining the program.  Once printed, these may
  2607.             be copied off to floppy or simply deleted.  Please review each of
  2608.             these files.
  2609.  
  2610.                 UBTSYSOP.DOC - SysOp Documentation
  2611.                 ----------------------------------
  2612.                 This is the SysOp documentation file you are currently reading.
  2613.                 This file contains all information for the installation, the
  2614.                 initialization, and the maintenance of the game.  Detailed
  2615.                 information is provided for all configurations, generation of
  2616.                 new scenarios, editor usage, etc..
  2617.  
  2618.                 UBOAT.DOC - User Documentation
  2619.                 ------------------------------
  2620.                 This file is the user documentation file.  It is avalable to
  2621.                 users to download in the documentation menu.  Encourage your
  2622.                 users to download and read this file as it will make the game
  2623.                 more enjoyable as opposed to constantly seeking online help.
  2624.  
  2625.                 UBOAT.ZIP - User Documentation (Compressed)
  2626.                 -------------------------------------------
  2627.                 This file is the compressed version of the user documentation
  2628.                 file above.  It is also availble through the documentation
  2629.                 menu.  If you prefer to user a different form of compression,
  2630.                 see the section on the configuration file command 'EXT2:'.
  2631.  
  2632.                 UBOAT-HP.PCL - User Documentation (PCL-4)
  2633.                 -----------------------------------------
  2634.                 This file is the documentation in HP Laserjet + compatible
  2635.                 format (PCL-4).
  2636.  
  2637.                 NOTE: THIS FILE IS NOT YET AVAILABLE.
  2638.  
  2639.                 UBOAT-HP.ZIP - User Documentation (PCL-4, Compressed)
  2640.                 -----------------------------------------------------
  2641.                 This file is the documentation in HP Laserjet + compatible
  2642.                 format (PCL-4) and that has been compressed.  See the
  2643.                 section on configuration file command 'EXT4:' if you wish to
  2644.                 use a different compression format.
  2645.  
  2646.                 NOTE: THIS FILE IS NOT YET AVAILABLE.
  2647.  
  2648.  
  2649.  
  2650.  
  2651.   ----------------------------------------------------------------------------
  2652.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2653.   U-Boat SysOps Documentation - Version 1.00                          Page B.2
  2654.   ----------------------------------------------------------------------------
  2655.  
  2656.                 UBOAT.CFG - Sample Configuration
  2657.                 --------------------------------
  2658.                 This file is a sample UBOAT.CFG file.  It is setup to con-
  2659.                 tain all of the commands with their default values.
  2660.  
  2661.                 REGISTER.TXT - Registration Information
  2662.                 ---------------------------------------
  2663.                 This file contains information on registering your copy of
  2664.                 U-Boat.  We encourage all SysOps who run the game to regis-
  2665.                 ter their copies.  It is suggested however that you use
  2666.                 the ORDER.TXT file to order your registered copy.
  2667.  
  2668.                 DOORS.TXT - Mycroft Door Descriptions
  2669.                 -------------------------------------
  2670.                 This file contains information on other door programs available
  2671.                 form Mycroft Systems.  Review this document at your leisure
  2672.                 to see if you would be interested in any other of our door
  2673.                 programs.
  2674.  
  2675.                 ORDER.TXT - Mycroft Door Order Form
  2676.                 -----------------------------------
  2677.                 This file is the Mycroft Doors-by-Mail order form.  Fill it
  2678.                 and and send it to any Mycroft Dealer to get the most recent
  2679.                 registered version sent to you by mail.  Please check the
  2680.                 "date valid through" line to check if pricing information is
  2681.                 still valid.  If the pricing information is out of date, you
  2682.                 can get an up-to-date price list by calling any Mycroft
  2683.                 Dealer.
  2684.  
  2685.                 DISTRIB.TXT - Mycroft Distributors List
  2686.                 ---------------------------------------
  2687.                 This file is a current list of Mycroft Distributors.  Please
  2688.                 note that Distributors are not Dealers.  Don not send orders
  2689.                 to them.  The Distributor List shows a complete list of BBSs
  2690.                 you may call to check on and download recent versions of
  2691.                 Mycroft Doors.  We hope there is one in your dialing area.  If
  2692.                 not, consider becomming a Mycroft Distributor yourself.
  2693.  
  2694.             B.2 Message Files
  2695.             -----------------
  2696.             The message files are those files containing text information that
  2697.             a user will see or read within the game.  These files are located
  2698.             in the MSGS subdirectory.  This section will describe the standard
  2699.             files shipped with the program.  These are the US (English) message
  2700.             bases.  Other languages will have the same support files with a
  2701.             different file extention.  See the section on multi-lingual support
  2702.             for more information.
  2703.  
  2704.                 UBOAT_S.ENG - Signon Screens
  2705.                 ----------------------------
  2706.                 This file contains all the screens used at game entry.  All of
  2707.                 the animation screens are in this file.
  2708.  
  2709.  
  2710.   ----------------------------------------------------------------------------
  2711.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2712.   U-Boat SysOps Documentation - Version 1.00                          Page B.3
  2713.   ----------------------------------------------------------------------------
  2714.  
  2715.                 UBOAT_M.ENG - Menus & Game Text
  2716.                 -------------------------------
  2717.                 This file contains most of the menus, the display screens, and
  2718.                 the messages used in U-Boat.
  2719.  
  2720.                 UBOAT_H.ENG - Help Text
  2721.                 -----------------------
  2722.                 This file contains all of the help screens, menus, and text
  2723.                 required to support the online help system built into the
  2724.                 game.
  2725.  
  2726.                 UBOAT_R.ENG - Error Text
  2727.                 ------------------------
  2728.                 This file contains all of the error messages the program is
  2729.                 capable of generating.
  2730.  
  2731.                 UBOAT_E.ENG - Editor Text
  2732.                 -------------------------
  2733.                 This file is the editor message file used in the various edi-
  2734.                 tors.  It contains all of the menus, display screens, prompts,
  2735.                 and other text used in the editor.
  2736.  
  2737.                 UBOAT_X.ENG - Editor Help Text
  2738.                 -------------------------------
  2739.                 This file contains all of the help screens, menus, and text
  2740.                 required to support online help for the editor.
  2741.  
  2742.             B.3 Program Files
  2743.             -----------------
  2744.             The program files reside in the main program directory.  They are
  2745.             used to run and configure the program as well as support some of
  2746.             the programs functions.  Here is a description of the program
  2747.             files.
  2748.  
  2749.                 UBOAT.BAT - Sample Batch File
  2750.                 -----------------------------
  2751.                 This file is a sample batch file that may be used or modified
  2752.                 to invoke U-Boat.  If you are using the INSTALL.EXE program,
  2753.                 a custom batch file will automatically be generated for you.
  2754.  
  2755.                 UBTXFER.BAT - Sample Download Batch File
  2756.                 ----------------------------------------
  2757.                 This file is a sample of the support file used to enable the
  2758.                 downloading of documentation from within the program.
  2759.  
  2760.                 UBOAT.EXE - Program Executable File
  2761.                 -----------------------------------
  2762.                 This file is the program executable file.  It consists of a
  2763.                 main body plus several overlays, which are built in, to run
  2764.                 the various sections of the program.
  2765.  
  2766.  
  2767.  
  2768.  
  2769.   ----------------------------------------------------------------------------
  2770.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2771.   U-Boat SysOps Documentation - Version 1.00                          Page B.4
  2772.   ----------------------------------------------------------------------------
  2773.  
  2774.                 UBOAT.CFG - Program Configuration File
  2775.                 --------------------------------------
  2776.                 This file is the game configuration file.  It is a standard
  2777.                 ASCII text file and mau be modified using a standard editor.
  2778.                 See the section on game configuration for details of this
  2779.                 file.  If you use the INSTALL.EXE program provided with this
  2780.                 door, then this file will automatically be built for you.
  2781.  
  2782.                 UBOAT.LNG - Language Selection File
  2783.                 -----------------------------------
  2784.                 This file is the language configuration file.  It is optional
  2785.                 and only used when you are configuring your version as a
  2786.                 multi-lingual version.  The file is a standard ASCII text
  2787.                 file and can be modified with a standard text editor.  See the
  2788.                 section on Multi-Lingual Support for more information.
  2789.  
  2790.                 UBOAT.ERR - Error Tracking File
  2791.                 -------------------------------
  2792.                 This file is the error tracking file.  Almost any error in
  2793.                 the program will generate a message to this file.  The error
  2794.                 will be recorded in the language selected in the configuration
  2795.                 file.  If the configuration file has not been read or if the
  2796.                 message file containing the error cannot be found then the
  2797.                 error will be recorded as:
  2798.  
  2799.                 Date: MMM DD YYYY   User: <user login>
  2800.                 Error [ErrorTag] -
  2801.  
  2802.                 Under normal circumstances, the error tag will be followed by
  2803.                 text from the message file.
  2804.  
  2805.                 UBTAUTH.MSG - Author Message File
  2806.                 ---------------------------------
  2807.                 This file contains a message from the author to the players.
  2808.                 It will usually contain information concerning new changes to
  2809.                 the program.  Whenever you install an updated version of
  2810.                 U-Boat, you should run the utility FLAGMSG against this file
  2811.                 to guarantee all users will see this message.  The file is a
  2812.                 standard ASCII text file.
  2813.  
  2814.                 UBTSYSOP.MSG - SysOp Message File
  2815.                 ---------------------------------
  2816.                 This file contains a message from the SysOp to the players.
  2817.                 It should be used to pass information to your players.  It
  2818.                 can be used in circumstances like your having changed the
  2819.                 game configuration via the editor.  The file is a standard
  2820.                 ASCII text file and can be modified using a standard text
  2821.                 editor.  Each line of the file is limited to 78 characters.
  2822.  
  2823.                 TIMEGEN.EXE - Timegen Utility
  2824.                 -----------------------------
  2825.                 This file is the Timegen Utility executable file.  This program
  2826.                 is used to impose limits on game access based by user security
  2827.  
  2828.   ----------------------------------------------------------------------------
  2829.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2830.   U-Boat SysOps Documentation - Version 1.00                          Page B.5
  2831.   ----------------------------------------------------------------------------
  2832.  
  2833.                 levels, time of day, and total time each day.  See the
  2834.                 installation section for more information.
  2835.  
  2836.                 TIMES.DEF - Sample Time Control File
  2837.                 ------------------------------------
  2838.                 This file is a sample time control source file.  The time
  2839.                 control source file is compiled using Timegen to generate the
  2840.                 time control file used by the game.
  2841.  
  2842.                 UBOAT.TIM - Game Time Control File
  2843.                 ----------------------------------
  2844.                 This file is a time control file for U-Boat.  The file is
  2845.                 completely optional and only need be used if you want to
  2846.                 restrict access to the program.  See the chapter on
  2847.                 installation for more information.
  2848.  
  2849.                 NODES.BBS - Node Definition File Sample
  2850.                 ---------------------------------------
  2851.                 This is a sample node ID file.  This file must be in the BBS
  2852.                 directory for the program to run remotely.  If you use the
  2853.                 INSTALL.EXE program, the file will automatically be built for
  2854.                 you.  The file is a standard ASCII text file and is described
  2855.                 in detail in the chapter on installation.
  2856.  
  2857.                 PORTS.BBS - Port Definition File Sample
  2858.                 ---------------------------------------
  2859.                 This is a sample communications port ID file.  This file, if
  2860.                 used,  must be in the BBS directory for the program to run
  2861.                 remotely.  If you use the Install Programs, the file will
  2862.                 automatically be built for you.  The file is a standard ASCII
  2863.                 text file and is described in detail in the chapter on
  2864.                 installation.
  2865.  
  2866.             B.4 Data Files
  2867.             --------------
  2868.             The Data Files in U-Boat reside, for the most part, in the main
  2869.             program directory.  The files that end in .DAT are the data
  2870.             files used by the game.
  2871.  
  2872.                 UBT-RATE.DAT - Player Ratings Data
  2873.                 ----------------------------------
  2874.                 This file is the player ratings file.  Records are kept for
  2875.                 the highest ratings as well as records for the highest scores
  2876.                 for each game.  It's contents may be viewed by using the
  2877.                 player ratings editor and the game high scores editor.
  2878.  
  2879.                 UBT-GAME.DAT - Games in Progress Data
  2880.                 -------------------------------------
  2881.                 This file is records for each of the games currently in pro-
  2882.                 gress.  The records are automatically reused as games are
  2883.                 completed and their records are freed.  You can view the
  2884.                 contents of this file by using the games in progress editor.
  2885.  
  2886.  
  2887.   ----------------------------------------------------------------------------
  2888.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2889.   U-Boat SysOps Documentation - Version 1.00                          Page B.6
  2890.   ----------------------------------------------------------------------------
  2891.  
  2892.                 UBT-PLYR.DAT - Player Data
  2893.                 --------------------------
  2894.                 This file is the player file.  Records are kept for each user
  2895.                 who has entered the game.  User records that are freed due
  2896.                 to a player being purged are automatically reused.  The
  2897.                 contents of this file may be viewed by using the player edi-
  2898.                 tor.
  2899.  
  2900.                 <bullet1> - Player Ratings Bulletin (B/W)
  2901.                 -----------------------------------------
  2902.                 The player ratings bulletin will display the top 10 rated
  2903.                 players in the game.  To qualify as a rated player, the
  2904.                 player must complete the first five scenarios at least once.
  2905.                 The filename and path for the bulletin are defined by the
  2906.                 configuration file command 'BULL:'.
  2907.  
  2908.                 <bullet2> - Player Ratings Bulletin (Color)
  2909.                 -------------------------------------------
  2910.                 This bulletin is identical to bulletin 1 except that it is
  2911.                 in color.  The filename and path for the bulletin are defi-
  2912.                 ned by the configuration file command 'BULLC:'.
  2913.  
  2914.                 <bullet3> - Game High Scores Bulletin (B/W)
  2915.                 -------------------------------------------
  2916.                 The game high scores bulletin will display the top 2 scores
  2917.                 acheived for each of the game scenarios.  The filename and
  2918.                 path are defined by the configuration file command 'BULL2:'.
  2919.  
  2920.                 <bullet4> - Game High Scores Bulletin (Color)
  2921.                 ---------------------------------------------
  2922.                 This bulletin is identical to bulletin 3 except that it is
  2923.                 in color.  The filename and path for the bulletin are defi-
  2924.                 ned by the configuration file command 'BULLC2:'.
  2925.  
  2926.  
  2927.  
  2928.  
  2929.  
  2930.  
  2931.  
  2932.  
  2933.  
  2934.  
  2935.  
  2936.  
  2937.  
  2938.  
  2939.  
  2940.  
  2941.  
  2942.  
  2943.  
  2944.  
  2945.  
  2946.   ----------------------------------------------------------------------------
  2947.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  2948.   U-Boat SysOps Documentation - Version 1.00                          Page C.1
  2949.   ----------------------------------------------------------------------------
  2950.  
  2951.         C.0 SysOp Function Keys
  2952.         =======================
  2953.         This appendix will describe the various keys available to SysOps while
  2954.         a user is within the program.
  2955.  
  2956.             [Alt F10]   This key will eject the current user from the game by
  2957.                         setting all his door access time to consumed.
  2958.  
  2959.             [Rgt Arrow] This key will add 1 minute of door access time to the
  2960.                         current users current door session.
  2961.  
  2962.             [Lft Arrow] This key will subtract 1 minute of door access time
  2963.                         from the current users current door session.
  2964.  
  2965.                 [F1]    The F1 key will toggle between the various help status
  2966.                         lines.  These lines will list all of the other SysOp
  2967.                         keys.
  2968.  
  2969.                 [F2]    The F2 key will temporarily turn off the snoop toggle.
  2970.                         It will then display information about the user, such
  2971.                         as when he/she logged into the game, when he/she will
  2972.                         run out of time, his password, etc.  To exit the user
  2973.                         information display, press the [END] key.
  2974.  
  2975.                 [F3]    The F3 key will temporarily turn off the snoop toggle.
  2976.                         It will then display information about the player,
  2977.                         such as his/her alias, his/her rating, etc..  To exit will
  2978.                         the player information display, press the [END] key.
  2979.  
  2980.                 [F4]    The F4 key will temporarily turn off the snoop toggle.
  2981.                         It will then display information about the game in
  2982.                         progress, such as turn number, transport score, game
  2983.                         scenario name, remaining number of transports, etc..
  2984.                         The game information display is only available when
  2985.                         the player is actively playing a scenario.  To exit
  2986.                         the game information display, press the [END] key.
  2987.  
  2988.                 [F5]    The F5 key will toggle the users access to the pro-
  2989.                         gram editors.  The status line will show an '*'
  2990.                         towards the right side when the user has access.
  2991.  
  2992.                 [F8]    The F8 key will toggle the state of the SysOp snoop
  2993.                         toggle.  Note that it is reset to its original state
  2994.                         when the BBS is reentered.  When this toggle is true,
  2995.                         the local screen will display the same information
  2996.                         as the remote screen.  When the toggle is false, the
  2997.                         local screen will remain blank display a single status
  2998.                         line that will be moved aproximately every 5 seconds.
  2999.  
  3000.                 [F9]    The F9 key will allow you to drop to a DOS shell.  The
  3001.                         player is notified that you have done so, and is locked
  3002.                         out until you return.  It is important that you remem-
  3003.                         ber to return to the main U-Boat directory before ty-
  3004.  
  3005.   ----------------------------------------------------------------------------
  3006.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  3007.   U-Boat SysOps Documentation - Version 1.00                          Page C.2
  3008.   ----------------------------------------------------------------------------
  3009.  
  3010.                         ping 'EXIT' to exit the DOS shell back to the game.
  3011.  
  3012.                 [F10]   The F10 key is used to initiate CHAT mode.  This allow
  3013.                         the SysOp to converse with the user via the keyboard
  3014.                         The CHAT in this program supports both automatic word
  3015.                         wrap, and also two tone chat mode.  Use the [ESC] key
  3016.                         to terminate chat mode.
  3017.  
  3018.  
  3019.  
  3020.  
  3021.  
  3022.  
  3023.  
  3024.  
  3025.  
  3026.  
  3027.  
  3028.  
  3029.  
  3030.  
  3031.  
  3032.  
  3033.  
  3034.  
  3035.  
  3036.  
  3037.  
  3038.  
  3039.  
  3040.  
  3041.  
  3042.  
  3043.  
  3044.  
  3045.  
  3046.  
  3047.  
  3048.  
  3049.  
  3050.  
  3051.  
  3052.  
  3053.  
  3054.  
  3055.  
  3056.  
  3057.  
  3058.  
  3059.  
  3060.  
  3061.  
  3062.  
  3063.  
  3064.   ----------------------------------------------------------------------------
  3065.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  3066.   U-Boat SysOps Documentation - Version 1.00                          Page D.1
  3067.   ----------------------------------------------------------------------------
  3068.  
  3069.         D.0 Command Line Options
  3070.         ========================
  3071.         This section covers the various command lines supported by U-Boat.
  3072.         The first group of command lines will run with either the shareware
  3073.         or the registered version.
  3074.  
  3075.         UBOAT                           Execute the program in local mode.
  3076.                                         The User is prompted for login and
  3077.                                         password.  No time controls apply
  3078.                                         except the keyboard timeout.
  3079.  
  3080.         UBOAT node                      Execute the program in G-Mon mode.
  3081.                                         G-Mon support files are scanned for
  3082.                                         user information.  "node" represents
  3083.                                         the BBS node number.
  3084.  
  3085.         UBOAT node path tag             Standard command line.  Executes
  3086.                                         U-Boat in remote BBS mode.  The 'node'
  3087.                                         parameter is the BBS node number,
  3088.                                         the 'path' parameter is the path to
  3089.                                         the BBS files, and 'tag' is the BBS
  3090.                                         tag ID.  The BBS interface files are
  3091.                                         scanned for the user info.
  3092.  
  3093.         UBOAT MAINTENANCE               Execute U-Boat program maintenance.
  3094.                                         This should be run once each every
  3095.                                         week or so.
  3096.  
  3097.  
  3098.         The following command lines work only with the registered version of
  3099.         U-Boat.
  3100.  
  3101.         UBOAT EDITOR                    Run the editor in local mode.  Login
  3102.                                         and password are still required.
  3103.  
  3104.         UBOAT node path tag EDITOR      Run the editor in remote mode.  The
  3105.                                         parameters are the same as running the
  3106.                                         game in remote BBS mode.  The login
  3107.                                         name is tested against allowed editor
  3108.                                         users, and a password is required.
  3109.  
  3110.  
  3111.  
  3112.  
  3113.  
  3114.  
  3115.  
  3116.  
  3117.  
  3118.  
  3119.  
  3120.  
  3121.  
  3122.  
  3123.   ----------------------------------------------------------------------------
  3124.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  3125.   U-Boat SysOps Documentation - Version 1.00                          Page E.1
  3126.   ----------------------------------------------------------------------------
  3127.  
  3128.         E.0 Multi-Lingual Support
  3129.         =========================
  3130.         U-Boat is one of the first Mycroft Door designed to support multiple
  3131.         human languages.  Language support is possible due to an inovative
  3132.         external message file system.  As time goes by, more and more Mycroft
  3133.         Doors will be converted to the multi-lingual support system.  Also
  3134.         more and more languages will be supported.
  3135.  
  3136.         In U-Boat, adding another language is as simple as 1, 2, 3.  1. Iden-
  3137.         tify the language you want to add; 2. Download the language support
  3138.         file (for U-Boat, these will be available as UBT-xxx.ZIP where the
  3139.         xxx in the language extention) and unzip it into the MSG subdirectory;
  3140.         3. Add a line to the language control file (for U-Boat this is
  3141.         UBOAT.LNG).
  3142.  
  3143.         The following languages are proposed to be supported at some point.
  3144.  
  3145.             ENG - English   code page 437    UKG - English   code page 850
  3146.             FRN - French    code page 437    FRC - French    code page 863
  3147.             SPN - Spanish   code page 437    SPS - Spanish   code page 850
  3148.             GRM - German    code page 437    GMN - German    code page 850
  3149.             ITL - Italian   code page 437    ITN - Italian   code page 850
  3150.             PTG - Portugese code page 437    PTU - Portugese code page 860
  3151.  
  3152.         If you are interested in doing a language conversion, please
  3153.         contact the author.
  3154.  
  3155.         To make the languages available to your users, you will need to
  3156.         create a language control file named UBOAT.LNG.  This file consists
  3157.         of 2 or more language definition records.  Each record is a single
  3158.         line.  The first part is a 3 character file extention, and the
  3159.         second part is the language definition text to be displayed in the
  3160.         language selection menu.  The following is a sample to offer English,
  3161.         French, and German:
  3162.  
  3163.                 ENG     English
  3164.                 FRN     Francais
  3165.                 GRM     Deutch
  3166.  
  3167.         We hope the multi-lingual support feature becomes a popular one and
  3168.         that many SysOps will volunteer to do language conversions.
  3169.  
  3170.  
  3171.  
  3172.  
  3173.  
  3174.  
  3175.  
  3176.  
  3177.  
  3178.  
  3179.  
  3180.  
  3181.  
  3182.   ----------------------------------------------------------------------------
  3183.   Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150       BBS: (408)927-0105
  3184.  
  3185.